org.sixdml
Interface SixdmlDatabase

All Superinterfaces:

Configurable, Database

All Known Implementing Classes:

xlnSixdmlDatabase

public interface SixdmlDatabase

extends Database

 SixdmlDatabase.java

 This is an encapsulation of the database driver functionality that is necessary 
 to access an XML database that understands SiXDML.

 Created: Thu Jan 10 17:46:25 2002
 

Version:

1.0

Author:

Dare Obasanjo

Method Summary

org.sixdml.dbmanagement.SixdmlIndex	createIndex(String name, HashMap indexFields) Creates an index with a name, an indexFields table and an underlying DXE database.
Resource	getResource(String name, String username, String password) Gets the specified resource from the database.
Service	getService(String name, String version) Returns a Service instance for the requested service name and version.
Service[]	getServices() Provides a list of all services known to the collection.
org.sixdml.dbmanagement.SixdmlIndexType[]	getSupportedIndexTypes() Gets the types of index that are supported by the this database.
org.sixdml.transform.SixdmlTransformType[]	getSupportedTransformTypes() Gets the types of transforms that are supported by the this database.

Methods inherited from interface org.xmldb.api.base.Database

acceptsURI, getCollection, getConformanceLevel, getName

Methods inherited from interface org.xmldb.api.base.Configurable

getProperty, setProperty

Method Detail

getResource

public Resource getResource(String name,
                            String username,
                            String password)
                     throws XMLDBException

Gets the specified resource from the database.

Parameters:

name - the resource to obtain.

username - The username to use for authentication to the database or null if the database does not support authentication.

password - The password to use for authentication to the database or null if the database does not support authentication.

Returns:

the requested resource.

XMLDBException

createIndex

public org.sixdml.dbmanagement.SixdmlIndex createIndex(String name,
                                                       HashMap indexFields)
                                                throws XMLDBException,
                                                       UnsupportedIndexTypeException

Creates an index with a name, an indexFields table and an underlying DXE database.
NOTE: Runtime error may occur if table not properly populated.

Parameters:

name - the name of the index.

indexFields - the index fields for the class.

Throws:

XMLDBException - if an error occurs.

UnsupportedIndexTypeException - if the type of index requested is unsupported by the database.

getSupportedIndexTypes

public org.sixdml.dbmanagement.SixdmlIndexType[] getSupportedIndexTypes()
                                                                 throws XMLDBException

Gets the types of index that are supported by the this database.

Returns:

an array of SixdmlIndexTypes which the database supports.

Throws:

XMLDBException - if an error occurs.

getSupportedTransformTypes

public org.sixdml.transform.SixdmlTransformType[] getSupportedTransformTypes()
                                                                      throws XMLDBException

Gets the types of transforms that are supported by the this database.

Returns:

an array of SixdmlTransformTypes which the database supports.

Throws:

XMLDBException - if an error occurs.

getServices

public Service[] getServices()
                      throws XMLDBException

Provides a list of all services known to the collection. If no services are known an empty list is returned.

Returns:

An array of registered Service implementations.

Throws:

XMLDBException - if an error occurs.

getService

public Service getService(String name,
                          String version)
                   throws XMLDBException

Returns a Service instance for the requested service name and version. If no Service exists for those parameters a null value is returned. The only valid name and version number for this implementation are "XSLT" and "1.0" respectively.

Parameters:

name - the name of the service to return.

version - the version number of the service to return.

Throws:

XMLDBException - if an error occurs.