org.apache.xindice.client.xmldb.services
Interface CollectionManager

All Known Implementing Classes:

CollectionManagementServiceImpl

public interface CollectionManager

CollectionManager provides management facilities for a Collection instance. Administrative access is required for retrieval of the CollectionManager interface. User level access is provided through the underlying Collection itself.

Version:

$Revision: 541508 $, $Date: 2007-05-24 21:54:12 -0400 (Thu, 24 May 2007) $

Method Summary

org.xmldb.api.base.Collection	createCollection(String path, org.w3c.dom.Document configuration) Creates a new collection in the database identified by name and using the provided configuration.
void	createIndexer(org.w3c.dom.Document configuration) Creates a new Indexer for this collection.
void	createXMLObject(org.w3c.dom.Document configuration) Creates a new collection level XMLObject using the provided configuration.
void	dropCollection(String name) Drops a child collection from this collection.
void	dropIndexer(String name) Drops the indexer from the collection
void	dropXMLObject(String name) Drops a collection level XMLObject from the collection.
String	getCanonicalName() Returns the fully qualified name of the collection that this manager is associated with.
String	getCollectionName() Returns the name of the collection that this manager is associated with.
String[]	listIndexers() Returns a list of all indexers for this collection.
String[]	listXMLObjects() Returns a list of all collection level XMLObjects for this collection.

Method Detail

getCollectionName

public String getCollectionName()
                         throws org.xmldb.api.base.XMLDBException

Returns the name of the collection that this manager is associated with.

Returns:

the name of the collection

Throws:

org.xmldb.api.base.XMLDBException

getCanonicalName

public String getCanonicalName()
                        throws org.xmldb.api.base.XMLDBException

Returns the fully qualified name of the collection that this manager is associated with. This name includes all parent collections.

Returns:

the fully qualified name for this collection.

Throws:

org.xmldb.api.base.XMLDBException

createCollection

public org.xmldb.api.base.Collection createCollection(String path,
                                                      org.w3c.dom.Document configuration)
                                               throws org.xmldb.api.base.XMLDBException

Creates a new collection in the database identified by name and using the provided configuration.

Parameters:

path - the path of the new collection

configuration - the XML collection configuration to use for creating this collection.

Returns:

The newly created collection

Throws:

org.xmldb.api.base.XMLDBException

dropCollection

public void dropCollection(String name)
                    throws org.xmldb.api.base.XMLDBException

Drops a child collection from this collection.

Parameters:

name - The name of the child collection to drop.

Throws:

org.xmldb.api.base.XMLDBException

listIndexers

public String[] listIndexers()
                      throws org.xmldb.api.base.XMLDBException

Returns a list of all indexers for this collection.

Returns:

the list of indexers

Throws:

org.xmldb.api.base.XMLDBException

createIndexer

public void createIndexer(org.w3c.dom.Document configuration)
                   throws org.xmldb.api.base.XMLDBException

Creates a new Indexer for this collection.

Parameters:

configuration - The configuration to use for this indexer.

Throws:

org.xmldb.api.base.XMLDBException

dropIndexer

public void dropIndexer(String name)
                 throws org.xmldb.api.base.XMLDBException

Drops the indexer from the collection

Parameters:

name - The name of the indexer to drop.

Throws:

org.xmldb.api.base.XMLDBException

listXMLObjects

public String[] listXMLObjects()
                        throws org.xmldb.api.base.XMLDBException

Returns a list of all collection level XMLObjects for this collection.

Returns:

the list of XMLObjects.

Throws:

org.xmldb.api.base.XMLDBException

createXMLObject

public void createXMLObject(org.w3c.dom.Document configuration)
                     throws org.xmldb.api.base.XMLDBException

Creates a new collection level XMLObject using the provided configuration. The XMLObject will be added to the collection using the provided name as a key.

Parameters:

configuration - The XML configuration to use

Throws:

org.xmldb.api.base.XMLDBException

dropXMLObject

public void dropXMLObject(String name)
                   throws org.xmldb.api.base.XMLDBException

Drops a collection level XMLObject from the collection.

Parameters:

name - The name of the XMLObject to drop.

Throws:

org.xmldb.api.base.XMLDBException