XML:DB API
A B C D E G H I L N O P Q R S T U V W X

A

acceptsURI(String) - Method in interface org.xmldb.api.base.Database
acceptsURI determines whether this Database implementation can handle the URI.
addAll(ResourceSet) - Method in interface org.xmldb.api.base.ResourceSet
Adds all Resource instances in the resourceSet to this set.
addResource(Resource) - Method in interface org.xmldb.api.base.ResourceSet
Adds a Resource instance to the set.

B

begin() - Method in interface org.xmldb.api.modules.TransactionService
Begin the transaction
BinaryResource - Interface in org.xmldb.api.modules
Resource for encapsulation of binary data that is stored in the data base.

C

clear() - Method in interface org.xmldb.api.base.ResourceSet
Removes all Resource instances from the set.
clearNamespaces() - Method in interface org.xmldb.api.modules.XPathQueryService
Removes all namespace mappings stored in the internal namespace map.
clearNamespaces() - Method in interface org.xmldb.api.modules.XQueryService
 
close() - Method in interface org.xmldb.api.base.Collection
Releases all resources consumed by the Collection.
Collection - Interface in org.xmldb.api.base
A Collection represents a collection of Resources stored within an XML database.
COLLECTION_CLOSED - Static variable in class org.xmldb.api.base.ErrorCodes
Set when an operation is invoked against a Collection instance that has been closed.
CollectionManagementService - Interface in org.xmldb.api.modules
CollectionManagementService is a Service that enables the basic management of collections within a database.
commit() - Method in interface org.xmldb.api.modules.TransactionService
Commit the transaction
compile(String) - Method in interface org.xmldb.api.modules.XQueryService
Compiles the specified XQuery and returns a handle to the compiled code, which can then be passed to XQueryService.execute(org.xmldb.api.base.CompiledExpression).
CompiledExpression - Interface in org.xmldb.api.base
 
Configurable - Interface in org.xmldb.api.base
Provides the ability to configure properties about an object.
createCollection(String) - Method in interface org.xmldb.api.modules.CollectionManagementService
Creates a new Collection in the database.
createId() - Method in interface org.xmldb.api.base.Collection
Creates a new unique ID within the context of the Collection
createResource(String, String) - Method in interface org.xmldb.api.base.Collection
Creates a new empty Resource with the provided id.

D

Database - Interface in org.xmldb.api.base
Database is an encapsulation of the database driver functionality that is necessary to access an XML database.
DatabaseManager - Class in org.xmldb.api
DatabaseManager is the entry point for the API and enables you to get the initial Collection references necessary to do anything useful with the API.
DatabaseManager() - Constructor for class org.xmldb.api.DatabaseManager
 
declareVariable(String, Object) - Method in interface org.xmldb.api.modules.XQueryService
Declare a global, external XQuery variable and assign a value to it.
deregisterDatabase(Database) - Static method in class org.xmldb.api.DatabaseManager
Deregisters a Database implementation from the DatabaseManager.

E

errorCode - Variable in exception org.xmldb.api.base.XMLDBException
 
ErrorCodes - Class in org.xmldb.api.base
ErrorCodes defines XML:DB error codes that can be used to set the errorCodes attribute of an XMLDBException
ErrorCodes() - Constructor for class org.xmldb.api.base.ErrorCodes
 
execute(CompiledExpression) - Method in interface org.xmldb.api.modules.XQueryService
Execute a compiled XQuery.

G

getCause() - Method in exception org.xmldb.api.base.XMLDBException
 
getChildCollection(String) - Method in interface org.xmldb.api.base.Collection
Returns a Collection instance for the requested child collection if it exists.
getChildCollectionCount() - Method in interface org.xmldb.api.base.Collection
Returns the number of child collections under this Collection or 0 if no child collections exist.
getCollection(String, String, String) - Method in interface org.xmldb.api.base.Database
Retrieves a Collection instance based on the URI provided in the uri parameter.
getCollection(String) - Static method in class org.xmldb.api.DatabaseManager
Retrieves a Collection instance from the database for the given URI.
getCollection(String, String, String) - Static method in class org.xmldb.api.DatabaseManager
Retrieves a Collection instance from the database for the given URI.
getConformanceLevel() - Method in interface org.xmldb.api.base.Database
Returns the XML:DB API Conformance level for the implementation.
getConformanceLevel(String) - Static method in class org.xmldb.api.DatabaseManager
Returns the Core Level conformance value for the provided URI.
getContent() - Method in interface org.xmldb.api.base.Resource
Retrieves the content from the resource.
getContentAsDOM() - Method in interface org.xmldb.api.modules.XMLResource
Returns the content of the Resource as a DOM Node.
getContentAsSAX(ContentHandler) - Method in interface org.xmldb.api.modules.XMLResource
Allows you to use a ContentHandler to parse the XML data from the database for use in an application.
getDatabases() - Static method in class org.xmldb.api.DatabaseManager
Returns a list of all available Database implementations that have been registered with this DatabaseManager.
getDocumentId() - Method in interface org.xmldb.api.modules.XMLResource
Returns the unique id for the parent document to this Resource or null if the Resource does not have a parent document.
getId() - Method in interface org.xmldb.api.base.Resource
Returns the unique id for this Resource or null if the Resource is anonymous.
getIterator() - Method in interface org.xmldb.api.base.ResourceSet
Returns an iterator over all Resource instances stored in the set.
getMembersAsResource() - Method in interface org.xmldb.api.base.ResourceSet
Returns a Resource containing an XML representation of all resources stored in the set.
getName() - Method in interface org.xmldb.api.base.Collection
Returns the name associated with the Collection instance.
getName() - Method in interface org.xmldb.api.base.Database
Deprecated. Replaced by String[] getNames().
getName() - Method in interface org.xmldb.api.base.Service
Returns the name associated with the Service instance.
getNames() - Method in interface org.xmldb.api.base.Database
Returns an array of names associated with the Database instance.
getNamespace(String) - Method in interface org.xmldb.api.modules.XPathQueryService
Returns the URI string associated with prefix from the internal namespace map.
getNamespace(String) - Method in interface org.xmldb.api.modules.XQueryService
Returns the URI string associated with prefix from the internal namespace map.
getParentCollection() - Method in interface org.xmldb.api.base.Collection
Returns the parent collection for this collection or null if no parent collection exists.
getParentCollection() - Method in interface org.xmldb.api.base.Resource
Returns the Collection instance that this resource is associated with.
getProperty(String) - Method in interface org.xmldb.api.base.Configurable
Returns the value of the property identified by name.
getProperty(String) - Static method in class org.xmldb.api.DatabaseManager
Retrieves a property that has been set for the DatabaseManager.
getResource(String) - Method in interface org.xmldb.api.base.Collection
Retrieves a Resource from the database.
getResource(int) - Method in interface org.xmldb.api.base.ResourceSet
Returns the Resource instance stored at the index specified by index.
getResourceCount() - Method in interface org.xmldb.api.base.Collection
Returns the number of resources currently stored in this collection or 0 if the collection is empty.
getResourceType() - Method in interface org.xmldb.api.base.Resource
Returns the resource type for this Resource.
getSAXFeature(String) - Method in interface org.xmldb.api.modules.XMLResource
Returns current setting of a SAX feature that will be used when this XMLResource is used to produce SAX events (through the getContentAsSAX() method)
getService(String, String) - Method in interface org.xmldb.api.base.Collection
Returns a Service instance for the requested service name and version.
getServices() - Method in interface org.xmldb.api.base.Collection
Provides a list of all services known to the collection.
getSize() - Method in interface org.xmldb.api.base.ResourceSet
Returns the number of resources contained in the set.
getVersion() - Method in interface org.xmldb.api.base.Service
Gets the Version attribute of the Service object

H

hasMoreResources() - Method in interface org.xmldb.api.base.ResourceIterator
Returns true as long as there are still more resources to be iterated.

I

INVALID_COLLECTION - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the Collection instance is in an invalid state.
INVALID_DATABASE - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the Database instance being registered is invalid.
INVALID_RESOURCE - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the Resource provided to an operation is invalid.
INVALID_URI - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the URI format is invalid.
isOpen() - Method in interface org.xmldb.api.base.Collection
Returns true if the Collection is open false otherwise.

L

listChildCollections() - Method in interface org.xmldb.api.base.Collection
Returns a list of collection names naming all child collections of the current collection.
listResources() - Method in interface org.xmldb.api.base.Collection
Returns a list of the ids for all resources stored in the collection.

N

nextResource() - Method in interface org.xmldb.api.base.ResourceIterator
Returns the next Resource instance in the iterator.
NO_SUCH_COLLECTION - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the requested Collection could not be located.
NO_SUCH_DATABASE - Static variable in class org.xmldb.api.base.ErrorCodes
Set if a Database instance can not be located for the provided URI.
NO_SUCH_RESOURCE - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the requested Resource could not be located.
NO_SUCH_SERVICE - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the requested Service could not be located.
NOT_IMPLEMENTED - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the API implementation does not support the operation being invoked.

O

org.xmldb.api - package org.xmldb.api
 
org.xmldb.api.base - package org.xmldb.api.base
 
org.xmldb.api.modules - package org.xmldb.api.modules
 

P

PERMISSION_DENIED - Static variable in class org.xmldb.api.base.ErrorCodes
Set if access to the requested Collection can not be granted due to the lack of proper credentials.
printStackTrace() - Method in exception org.xmldb.api.base.XMLDBException
 
printStackTrace(PrintStream) - Method in exception org.xmldb.api.base.XMLDBException
 
printStackTrace(PrintWriter) - Method in exception org.xmldb.api.base.XMLDBException
 

Q

query(String) - Method in interface org.xmldb.api.modules.XPathQueryService
Run an XPath query against the Collection.
query(String) - Method in interface org.xmldb.api.modules.XQueryService
 
queryResource(String, String) - Method in interface org.xmldb.api.modules.XPathQueryService
Run an XPath query against an XML resource stored in the Collection associated with this service.
queryResource(String, String) - Method in interface org.xmldb.api.modules.XQueryService
 

R

registerDatabase(Database) - Static method in class org.xmldb.api.DatabaseManager
Registers a new Database implementation with the DatabaseManager.
removeCollection(String) - Method in interface org.xmldb.api.modules.CollectionManagementService
Removes a named Collection from the system.
removeNamespace(String) - Method in interface org.xmldb.api.modules.XPathQueryService
Removes the namespace mapping associated with prefix from the internal namespace map.
removeNamespace(String) - Method in interface org.xmldb.api.modules.XQueryService
Removes the namespace mapping associated with prefix from the internal namespace map.
removeResource(Resource) - Method in interface org.xmldb.api.base.Collection
Removes the Resource from the database.
removeResource(int) - Method in interface org.xmldb.api.base.ResourceSet
Removes the Resource located at index from the set.
reset() - Method in interface org.xmldb.api.base.CompiledExpression
Prepare the expression for being reused.
Resource - Interface in org.xmldb.api.base
Resource is a container for data stored within the database.
RESOURCE_TYPE - Static variable in interface org.xmldb.api.modules.BinaryResource
 
RESOURCE_TYPE - Static variable in interface org.xmldb.api.modules.XMLResource
 
ResourceIterator - Interface in org.xmldb.api.base
ResourceIterator is used to iterate over a set of resources.
ResourceSet - Interface in org.xmldb.api.base
ResourceSet is a container for a set of resources.
rollback() - Method in interface org.xmldb.api.modules.TransactionService
Rollback the transaction

S

Service - Interface in org.xmldb.api.base
The Service interface provides an extension mechanism for Collection implementations.
SERVICE_NAME - Static variable in interface org.xmldb.api.modules.CollectionManagementService
 
SERVICE_NAME - Static variable in interface org.xmldb.api.modules.TransactionService
 
SERVICE_NAME - Static variable in interface org.xmldb.api.modules.XPathQueryService
 
SERVICE_NAME - Static variable in interface org.xmldb.api.modules.XQueryService
 
SERVICE_NAME - Static variable in interface org.xmldb.api.modules.XUpdateQueryService
 
setCollection(Collection) - Method in interface org.xmldb.api.base.Service
Sets the Collection attribute of the Service object
setContent(Object) - Method in interface org.xmldb.api.base.Resource
Sets the content for this resource.
setContentAsDOM(Node) - Method in interface org.xmldb.api.modules.XMLResource
Sets the content of the Resource using a DOM Node as the source.
setContentAsSAX() - Method in interface org.xmldb.api.modules.XMLResource
Sets the content of the Resource using a SAX ContentHandler.
setModuleLoadPath(String) - Method in interface org.xmldb.api.modules.XQueryService
 
setNamespace(String, String) - Method in interface org.xmldb.api.modules.XPathQueryService
Sets a namespace mapping in the internal namespace map used to evaluate queries.
setNamespace(String, String) - Method in interface org.xmldb.api.modules.XQueryService
Sets a namespace mapping in the internal namespace map used to evaluate queries.
setProperty(String, String) - Method in interface org.xmldb.api.base.Configurable
Sets the property name to have the value provided in value.
setProperty(String, String) - Static method in class org.xmldb.api.DatabaseManager
Sets a property for the DatabaseManager.
setSAXFeature(String, boolean) - Method in interface org.xmldb.api.modules.XMLResource
Sets a SAX feature that will be used when this XMLResource is used to produce SAX events (through the getContentAsSAX() method)
setXPathCompatibility(boolean) - Method in interface org.xmldb.api.modules.XQueryService
Enable or disable XPath 1.0 compatibility mode.
storeResource(Resource) - Method in interface org.xmldb.api.base.Collection
Stores the provided resource into the database.

T

TransactionService - Interface in org.xmldb.api.modules
Provides the ability to bundle Collection operations into a transaction.

U

UNKNOWN_ERROR - Static variable in class org.xmldb.api.base.ErrorCodes
Set when a more detailed error can not be determined.
UNKNOWN_RESOURCE_TYPE - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the resource type requested is unknown to the API implementation.
update(String) - Method in interface org.xmldb.api.modules.XUpdateQueryService
Runs a set of XUpdate operations against the collection.
updateResource(String, String) - Method in interface org.xmldb.api.modules.XUpdateQueryService
Runs a set of XUpdate operations against a resource stored in a collection.

V

VENDOR_ERROR - Static variable in class org.xmldb.api.base.ErrorCodes
Set when a vendor specific error has occured.
vendorErrorCode - Variable in exception org.xmldb.api.base.XMLDBException
 

W

WRONG_CONTENT_TYPE - Static variable in class org.xmldb.api.base.ErrorCodes
Set if the content of a Resource is set to a content type different then that for which the Resource was intended to support.

X

XMLDBException - Exception in org.xmldb.api.base
XMLDBException is thrown for all errors in the XML:DB API.
XMLDBException() - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLDBException(int) - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLDBException(int, String) - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLDBException(int, int) - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLDBException(int, int, String) - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLDBException(int, Throwable) - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLDBException(int, String, Throwable) - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLDBException(int, int, Throwable) - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLDBException(int, int, String, Throwable) - Constructor for exception org.xmldb.api.base.XMLDBException
 
XMLResource - Interface in org.xmldb.api.modules
Provides access to XML resources stored in the database.
XPathQueryService - Interface in org.xmldb.api.modules
XPathQueryService is a Service that enables the execution of XPath queries within the context of a Collection or against a single XML Resource stored in the Collection.
XQueryService - Interface in org.xmldb.api.modules
 
XUpdateQueryService - Interface in org.xmldb.api.modules
XUpdateQueryService is a Service that enables the execution of XUpdate queries within the context of a Collection or against a single document stored in a collection.

A B C D E G H I L N O P Q R S T U V W X
XML:DB API

Copyright (C) XML:DB Initiative. All rights reserved.%lt;/font>