org.xmldb.api.sdk

Class SimpleDatabase

Implemented Interfaces:
Configurable, Database
Known Direct Subclasses:
DatabaseImpl

public abstract class SimpleDatabase
extends SimpleConfigurable
implements Database

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.

Field Summary

protected static String
CONFORMANCE_LEVEL
The XML:DB API Core Level Conformance of this implementation.
protected static String
INSTANCE_NAME
Name used in the uri for collections associated with this instance.

Method Summary

boolean
acceptsURI(String uri)
acceptsURI determines whether this Database implementation can handle the URI.
Collection
getCollection(String uri, String username, String password)
Retrieves a Collection instance based on the URI provided in the uri parameter.
String
getConformanceLevel()
Returns the XML:DB API Conformance level for the implementation.
String
getName()
Returns the name associated with the Configurable object.

Methods inherited from class org.xmldb.api.sdk.SimpleConfigurable

getProperty, setProperty

Field Details

CONFORMANCE_LEVEL

protected static String CONFORMANCE_LEVEL
The XML:DB API Core Level Conformance of this implementation.

INSTANCE_NAME

protected static String INSTANCE_NAME
Name used in the uri for collections associated with this instance.

Method Details

acceptsURI

public boolean acceptsURI(String uri)
            throws XMLDBException
acceptsURI determines whether this Database implementation can handle the URI.
Specified by:
acceptsURI in interface Database
Parameters:
uri - the URI to check for.
Returns:
true if the URI can be handled, false otherwise.

getCollection

public Collection getCollection(String uri,
                                String username,
                                String password)
            throws XMLDBException
Retrieves a Collection instance based on the URI provided in the uri parameter. Implementations must override this method.
Specified by:
getCollection in interface Database
Parameters:
uri - the URI to use to locate the collection.
Returns:
The Collection instance

getConformanceLevel

public String getConformanceLevel()
            throws XMLDBException
Returns the XML:DB API Conformance level for the implementation.
Specified by:
getConformanceLevel in interface Database
Returns:
the XML:DB API conformance level for this implementation.

getName

public String getName()
            throws XMLDBException
Returns the name associated with the Configurable object.
Specified by:
getName in interface Database