org.sixdml.dbmanagement
Interface SixdmlCollectionManagementService

All Superinterfaces:

CollectionManagementService, Configurable, Service

All Known Implementing Classes:

xiSixdmlCollectionManagementService

public interface SixdmlCollectionManagementService

extends CollectionManagementService

 SixdmlCollectionManagementService.java

 This is a Service that enables the basic management of collections within a 
 database. 

 Created: Fri Jan 11 01:07:58 2002
 

Version:

1.0

Author:

Dare Obasanjo

Method Summary

Collection	createCollection(String name, URL schemaFile) Creates a collection that is constrained by a particular schema.
SixdmlIndex	createIndex(String name, HashMap indexFields) Creates an index with a name, an indexFields table and an underlying DXE database.
SixdmlIndexType[]	getSupportedIndexTypes() Gets the types of index that are supported by the this database.

Methods inherited from interface org.xmldb.api.modules.CollectionManagementService

createCollection, removeCollection

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

getName, getVersion, setCollection

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

getProperty, setProperty

Method Detail

createCollection

public Collection createCollection(String name,
                                   URL schemaFile)
                            throws XMLDBException,
                                   IOException,
                                   InvalidSchemaException

Creates a collection that is constrained by a particular schema.

Parameters:

name - The name of the collection to create.

schemaFile - the location of the schema file either on the local file system or over the internet.

Throws:

XMLDBException - if a database error occurs.

IOException - if an error occurs while trying to retrieve the file.

InvalidSchemaException - if the schema is invalid.

createIndex

public 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 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.