org.xmldb.api.base
Interface Database

All Superinterfaces:
Configurable
All Known Implementing Classes:
DatabaseImpl

public interface Database
extends Configurable

Database is an encapsulation of the database driver functionality that is necessary to access an XML database. Each vendor must provide their own implmentation of the Database interface. The implementation is registered with the DatabaseManager to provide access to the resources of the XML database.

In general usage client applications should only access Database implementations directly during initialization.


Method Summary
 boolean acceptsURI(java.lang.String uri)
          acceptsURI determines whether this Database implementation can handle the URI.
 Collection getCollection(java.lang.String uri)
          Retrieves a Collection instance based on the URI provided in the uri parameter.
 java.lang.String getConformanceLevel()
          Returns the XML:DB API Conformance level for the implementation.
 
Methods inherited from interface org.xmldb.api.base.Configurable
getName, getProperty, setProperty
 

Method Detail

getCollection

public Collection getCollection(java.lang.String uri)
                         throws XMLDBException
Retrieves a Collection instance based on the URI provided in the uri parameter. The format of the URI is defined in the documentation for DatabaseManager.getCollection().

Parameters:
uri - the URI to use to locate the collection.
Returns:
The Collection instance
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.
ErrroCodes.INVALID_URI If the URI is not in a valid format.

acceptsURI

public boolean acceptsURI(java.lang.String uri)
                   throws XMLDBException
acceptsURI determines whether this Database implementation can handle the URI. It should return true if the Database instance knows how to handle the URI and false otherwise.

Parameters:
uri - the URI to check for.
Returns:
true if the URI can be handled, false otherwise.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.
ErrroCodes.INVALID_URI If the URI is not in a valid format.

getConformanceLevel

public java.lang.String getConformanceLevel()
                                     throws XMLDBException
Returns the XML:DB API Conformance level for the implementation. This can be used by client programs to determine what functionality is available to them.

Returns:
the XML:DB API conformance level for this implementation.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.


Copyright © 2004 The Ozone Database Project - www.ozone-db.org. All Rights Reserved.