- characters(char[], int, int) - Method in class org.xmldb.api.sdk.modules.SetContentHandler
-
Receive notification of character data inside an element.
- checkCapabilities(Database) - Method in class org.xmldb.api.tests.XMLDBTestCase
-
- checkOpen() - Method in class org.xmldb.api.sdk.SimpleCollection
-
Throws an exception if the collection is not open.
- clear() - Method in interface org.xmldb.api.base.ResourceSet
-
Removes all Resource
instances from the set.
- clear() - Method in class org.xmldb.api.sdk.SimpleResourceSet
-
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 class org.xmldb.api.sdk.modules.SimpleXPathQueryService
-
Removes all namespace mappings stored in the internal namespace map.
- close() - Method in interface org.xmldb.api.base.Collection
-
Releases all resources consumed by the Collection
.
- close() - Method in class org.xmldb.api.reference.CollectionImpl
-
Releases all resources consumed by the Collection
.
- close() - Method in class org.xmldb.api.sdk.SimpleCollection
-
Releases all resources consumed by the Collection
.
- col - Variable in class org.xmldb.api.tests.XMLDBTestCase
-
- Collection - Interface in org.xmldb.api.base
-
A Collection
represents a collection of Resource
s
stored within an XML
database.
- collection - Variable in class org.xmldb.api.reference.CollectionImpl
-
- collection - Variable in class org.xmldb.api.reference.modules.CollectionManagementServiceImpl
-
- collection - Variable in class org.xmldb.api.sdk.SimpleResourceSet
-
- 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.
- CollectionImpl - Class in org.xmldb.api.reference
-
A Collection
is implemented as a directory in the file system.
- CollectionImpl(String) - Constructor for class org.xmldb.api.reference.CollectionImpl
-
- CollectionManagementService - Interface in org.xmldb.api.modules
-
CollectionManagementService is a Service
that enables the basic
management of collections within a database.
- CollectionManagementServiceImpl - Class in org.xmldb.api.reference.modules
-
CollectionManager provides management facilities for a Collection instance.
- CollectionManagementServiceImpl(String) - Constructor for class org.xmldb.api.reference.modules.CollectionManagementServiceImpl
-
Creates a new CollectionManager service
- CollectionTest - Class in org.xmldb.api.tests
-
- CollectionTest(String) - Constructor for class org.xmldb.api.tests.CollectionTest
-
- collectionURI - Variable in class org.xmldb.api.tests.XMLDBTestCase
-
- commit() - Method in interface org.xmldb.api.modules.TransactionService
-
Commit the transaction
- commit() - Method in class org.xmldb.api.reference.modules.TransactionServiceImpl
-
Commit the transaction
- commit() - Method in class org.xmldb.api.sdk.modules.SimpleTransactionService
-
Commit the transaction
- config - Variable in class org.xmldb.api.tests.XMLDBTestCase
-
- Configurable - Interface in org.xmldb.api.base
-
Provides the ability to configure properties about an object.
- CONFORMANCE_LEVEL - Static variable in class org.xmldb.api.sdk.SimpleDatabase
-
The XML:DB API Core Level Conformance of this implementation.
- content - Variable in class org.xmldb.api.sdk.modules.BaseResource
-
- content - Variable in class org.xmldb.api.sdk.modules.SimpleBinaryResource
-
- content - Variable in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
- createCollection(String) - Method in interface org.xmldb.api.modules.CollectionManagementService
-
Creates a new Collection
in the database.
- createCollection(String) - Method in class org.xmldb.api.reference.modules.CollectionManagementServiceImpl
-
Creates a simple collection with a basic default configuration.
- createId() - Method in interface org.xmldb.api.base.Collection
-
Creates a new unique ID within the context of the Collection
- createId() - Method in class org.xmldb.api.reference.CollectionImpl
-
Creates a new unique ID within the context of the Collection
- createId() - Method in class org.xmldb.api.sdk.SimpleCollection
-
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.
- createResource(String, String) - Method in class org.xmldb.api.reference.CollectionImpl
-
Creates a new empty Resource
with the provided id.
- createResource(String, String) - Method in class org.xmldb.api.sdk.SimpleCollection
-
Creates a new empty Resource
with the provided id.
- getChildCollection(String) - Method in interface org.xmldb.api.base.Collection
-
Returns a Collection
instance for the requested child collection
if it exists.
- getChildCollection(String) - Method in class org.xmldb.api.reference.CollectionImpl
-
Returns a Collection
instance for the requested child collection
if it exists.
- getChildCollection(String) - Method in class org.xmldb.api.sdk.SimpleCollection
-
Default behaviour for a non-hierarchical implementation
- 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.
- getChildCollectionCount() - Method in class org.xmldb.api.reference.CollectionImpl
-
Returns the number of child collections under this
Collection
.
- getChildCollectionCount() - Method in class org.xmldb.api.sdk.SimpleCollection
-
Default behaviour for a non-hierarchical implementation
- 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.
- getCollection(String, String, String) - Method in class org.xmldb.api.reference.DatabaseImpl
-
Retrieves a Collection
instance based on the URI provided
in the uri
parameter.
- getCollection(String, String, String) - Method in class org.xmldb.api.sdk.SimpleDatabase
-
Retrieves a Collection
instance based on the URI provided
in the uri
parameter.
- 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.
- getConformanceLevel() - Method in class org.xmldb.api.sdk.SimpleDatabase
-
Returns the XML:DB API Conformance level for the implementation.
- getContent() - Method in interface org.xmldb.api.base.Resource
-
Retrieves the content from the resource.
- getContent() - Method in class org.xmldb.api.sdk.modules.SimpleBinaryResource
-
Retrieves the content from the resource.
- getContent() - Method in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
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.
- getContentAsDOM() - Method in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
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.
- getContentAsSAX(ContentHandler) - Method in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
Allows you to use a ContentHandler
to parse the XML data from
the database for use in an application.
- getDatabase(String) - Static method in class org.xmldb.api.DatabaseManager
-
Retrieves the registered Database
instance associated with the provided
URI.
- 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.
- getDocumentId() - Method in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
Returns the ID for the parent document of this resource.
- getId() - Method in interface org.xmldb.api.base.Resource
-
Returns the unique id for this Resource
or null if the
Resource
is anonymous.
- getId() - Method in class org.xmldb.api.sdk.modules.BaseResource
-
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.
- getIterator() - Method in class org.xmldb.api.sdk.SimpleResourceSet
-
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.
- getMembersAsResource() - Method in class org.xmldb.api.reference.ResourceSetImpl
-
Returns a Resource
containing an XML representation of all
resources stored in the set.
- getMembersAsResource() - Method in class org.xmldb.api.sdk.SimpleResourceSet
-
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
-
Returns the name associated with the Database instance.
- getName() - Method in interface org.xmldb.api.base.Service
-
Returns the name associated with the Service instance.
- getName() - Method in class org.xmldb.api.reference.CollectionImpl
-
Returns the name of the collection
- getName() - Method in class org.xmldb.api.reference.modules.CollectionManagementServiceImpl
-
Returns the name of the Service
- getName() - Method in class org.xmldb.api.reference.modules.TransactionServiceImpl
-
Returns the name associated with the Configurable object.
- getName() - Method in class org.xmldb.api.reference.modules.XPathQueryServiceImpl
-
Returns the name associated with the Configurable object.
- getName() - Method in class org.xmldb.api.sdk.modules.SimpleTransactionService
-
Returns the name associated with the Configurable object.
- getName() - Method in class org.xmldb.api.sdk.modules.SimpleXPathQueryService
-
Returns the service name
- getName() - Method in class org.xmldb.api.sdk.SimpleCollection
-
Returns the name associated with the Configurable object.
- getName() - Method in class org.xmldb.api.sdk.SimpleDatabase
-
Returns the name associated with the Configurable object.
- 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 class org.xmldb.api.sdk.modules.SimpleXPathQueryService
-
Returns the URI string associated with prefix
.
- 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.
- getParentCollection() - Method in class org.xmldb.api.reference.CollectionImpl
-
Returns the parent collection for this collection or null if no parent
collection exists.
- getParentCollection() - Method in class org.xmldb.api.sdk.modules.BaseResource
-
Returns the Collection
instance that this resource is
associated with.
- getParentCollection() - Method in class org.xmldb.api.sdk.SimpleCollection
-
Default behaviour for a non-hierarchical implementation
- 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
.
- getProperty(String) - Method in class org.xmldb.api.sdk.SimpleConfigurable
-
Returns the value of the property identified by name
.
- getResource(String) - Method in interface org.xmldb.api.base.Collection
-
Retrieves a Resource
from the database.
- getResource(long) - Method in interface org.xmldb.api.base.ResourceSet
-
Returns the Resource
instance stored at the index specified
by index.
- getResource(String) - Method in class org.xmldb.api.reference.CollectionImpl
-
Retrieves a Resource
from the database.
- getResource(String) - Method in class org.xmldb.api.sdk.SimpleCollection
-
Retrieves a Resource
from the database.
- getResource(long) - Method in class org.xmldb.api.sdk.SimpleResourceSet
-
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.
- getResourceCount() - Method in class org.xmldb.api.reference.CollectionImpl
-
Returns the number of resources currently stored in this collection or 0
if the collection is empty.
- getResourceCount() - Method in class org.xmldb.api.sdk.SimpleCollection
-
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.
- getResourceType() - Method in class org.xmldb.api.sdk.modules.SimpleBinaryResource
-
Returns the resource type for this Resource.
- getResourceType() - Method in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
Returns the resource type for this Resource.
- getService(String, String) - Method in interface org.xmldb.api.base.Collection
-
Returns a Service
instance for the requested service name and version.
- getService(String, String) - Method in class org.xmldb.api.sdk.SimpleCollection
-
Get a Service instance based on the name and version.
- getServices() - Method in interface org.xmldb.api.base.Collection
-
Provides a list of all services known to the collection.
- getServices() - Method in class org.xmldb.api.sdk.SimpleCollection
-
Returns the list of Services supported by this Collection.
- getSize() - Method in interface org.xmldb.api.base.ResourceSet
-
Returns the number of resources contained in the set.
- getSize() - Method in class org.xmldb.api.sdk.SimpleResourceSet
-
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
- getVersion() - Method in class org.xmldb.api.reference.modules.CollectionManagementServiceImpl
-
Returns the version of the Service
- getVersion() - Method in class org.xmldb.api.reference.modules.TransactionServiceImpl
-
Gets the Version attribute of the Service object
- getVersion() - Method in class org.xmldb.api.reference.modules.XPathQueryServiceImpl
-
Gets the Version attribute of the Service object
- getVersion() - Method in class org.xmldb.api.sdk.modules.SimpleTransactionService
-
Gets the Version attribute of the Service object
- getVersion() - Method in class org.xmldb.api.sdk.modules.SimpleXPathQueryService
-
Returns the version of the Service
- SEP - Static variable in class org.xmldb.api.reference.DatabaseImpl
-
The characters expected to separate the INSTANCE_NAME from the file system
path
- serialize(Node) - Method in class org.xmldb.api.reference.ResourceSetImpl
-
- Service - Interface in org.xmldb.api.base
-
The Service
interface provides an extension mechanism for
Collection
implementations.
- services - Variable in class org.xmldb.api.sdk.SimpleCollection
-
- setCollection(Collection) - Method in interface org.xmldb.api.base.Service
-
Sets the Collection attribute of the Service object
- setCollection(Collection) - Method in class org.xmldb.api.reference.modules.CollectionManagementServiceImpl
-
Provides a reference to the XML:DB collection instance that this service
is associated with.
- setCollection(Collection) - Method in class org.xmldb.api.reference.modules.TransactionServiceImpl
-
Sets the Collection attribute of the Service object
- setCollection(Collection) - Method in class org.xmldb.api.reference.modules.XPathQueryServiceImpl
-
Sets the Collection attribute of the Service object
- setCollection(Collection) - Method in class org.xmldb.api.sdk.modules.SimpleTransactionService
-
Sets the Collection attribute of the Service object
- setCollection(Collection) - Method in class org.xmldb.api.sdk.modules.SimpleXPathQueryService
-
Sets the Collection attribute of the Service object
- setContent(Object) - Method in interface org.xmldb.api.base.Resource
-
Sets the content for this resource.
- setContent(Object) - Method in class org.xmldb.api.sdk.modules.SimpleBinaryResource
-
Sets the content for this resource.
- setContent(Object) - Method in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
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.
- setContentAsDOM(Node) - Method in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
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
.
- setContentAsSAX() - Method in class org.xmldb.api.sdk.modules.SimpleXMLResource
-
Sets the content of the Resource
using a SAX
ContentHandler
.
- SetContentHandler - Class in org.xmldb.api.sdk.modules
-
Simple ContentHandler that just converts the SAX event stream into a text
representation of the document and stores it in the associated resource.
- SetContentHandler(XMLResource) - Constructor for class org.xmldb.api.sdk.modules.SetContentHandler
-
- 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 class org.xmldb.api.sdk.modules.SimpleXPathQueryService
-
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
.
- setProperty(String, String) - Method in class org.xmldb.api.sdk.SimpleConfigurable
-
Sets the property name
to have the value provided in
value
.
- setUp() - Method in class org.xmldb.api.tests.XMLDBTestCase
-
- SimpleBinaryResource - Class in org.xmldb.api.sdk.modules
-
Resource for encapsulation of binary data that is stored in the data base.
- SimpleBinaryResource(Collection, String) - Constructor for class org.xmldb.api.sdk.modules.SimpleBinaryResource
-
Create a new BinaryResource without any content.
- SimpleBinaryResource(Collection, String, byte[]) - Constructor for class org.xmldb.api.sdk.modules.SimpleBinaryResource
-
Create a fully initialized BinaryResource
- SimpleCollection - Class in org.xmldb.api.sdk
-
SimpleCollection provides an easy starting point for implementing the
Collection interface.
- SimpleCollection() - Constructor for class org.xmldb.api.sdk.SimpleCollection
-
- SimpleConfigurable - Class in org.xmldb.api.sdk
-
Provides the ability to configure properties about an object.
- SimpleConfigurable() - Constructor for class org.xmldb.api.sdk.SimpleConfigurable
-
- SimpleDatabase - Class in org.xmldb.api.sdk
-
Simple
Database
implementation intended to be used as a base
class for a specific implementation.
Extending classes MUST set INSTANCE_NAME and SHOULD set CONFORMANCE_LEVEL to
values appropriate for their specific implementation.
- SimpleDatabase() - Constructor for class org.xmldb.api.sdk.SimpleDatabase
-
- SimpleResourceIterator - Class in org.xmldb.api.sdk
-
ResourceIterator is used to iterate over a set of resources.
- SimpleResourceIterator(List) - Constructor for class org.xmldb.api.sdk.SimpleResourceIterator
-
- SimpleResourceSet - Class in org.xmldb.api.sdk
-
Provides a base ResourceSet implementation that utilizes a synchronized list
to contain the set of resources.
- SimpleResourceSet() - Constructor for class org.xmldb.api.sdk.SimpleResourceSet
-
- SimpleTransactionService - Class in org.xmldb.api.sdk.modules
-
Provides the ability to bundle Collection
operations into a
transaction.
- SimpleTransactionService() - Constructor for class org.xmldb.api.sdk.modules.SimpleTransactionService
-
- SimpleXMLResource - Class in org.xmldb.api.sdk.modules
-
Provides access to XML resources stored in the database.
- SimpleXMLResource(Collection, String, String) - Constructor for class org.xmldb.api.sdk.modules.SimpleXMLResource
-
Create a new XMLResource without any content.
- SimpleXMLResource(Collection, String, String, String) - Constructor for class org.xmldb.api.sdk.modules.SimpleXMLResource
-
Create a fully initialized XMLResource
- SimpleXPathQueryService - Class in org.xmldb.api.sdk.modules
-
XPathQueryService is a Service
that enables the execution of
XPath queries within the context of a Collection
.
- SimpleXPathQueryService() - Constructor for class org.xmldb.api.sdk.modules.SimpleXPathQueryService
-
- skippedEntity(String) - Method in class org.xmldb.api.sdk.modules.SetContentHandler
-
Receive notification of a skipped entity.
- startDocument() - Method in class org.xmldb.api.sdk.modules.SetContentHandler
-
Receive notification of the beginning of the document.
- startElement(String, String, String, Attributes) - Method in class org.xmldb.api.sdk.modules.SetContentHandler
-
Receive notification of the start of an element.
- startPrefixMapping(String, String) - Method in class org.xmldb.api.sdk.modules.SetContentHandler
-
Receive notification of the start of a Namespace mapping.
- storeResource(Resource) - Method in interface org.xmldb.api.base.Collection
-
Stores the provided resource into the database.
- storeResource(Resource) - Method in class org.xmldb.api.reference.CollectionImpl
-
Stores the provided resource into the database.
- storeResource(Resource) - Method in class org.xmldb.api.sdk.SimpleCollection
-
Stores the provided resource into the database.
- stripURIPrefix(String) - Static method in class org.xmldb.api.DatabaseManager
-
Removes the URI_PREFIX from the front of the URI.
- suite() - Static method in class org.xmldb.api.tests.AllTests
-
- suite() - Static method in class org.xmldb.api.tests.CollectionTest
-
- suite() - Static method in class org.xmldb.api.tests.ResourceTest
-
- suite() - Static method in class org.xmldb.api.tests.XMLDBTestSuite
-
- supportsBinary - Variable in class org.xmldb.api.tests.XMLDBTestCase
-
- supportsManagement - Variable in class org.xmldb.api.tests.XMLDBTestCase
-
- supportsNested - Variable in class org.xmldb.api.tests.XMLDBTestCase
-
- supportsTransactions - Variable in class org.xmldb.api.tests.XMLDBTestCase
-
- supportsXPath - Variable in class org.xmldb.api.tests.XMLDBTestCase
-
- supportsXUpdate - Variable in class org.xmldb.api.tests.XMLDBTestCase
-