org.xmldb.api.reference.modules

Class CollectionManagementServiceImpl

public class CollectionManagementServiceImpl extends SimpleConfigurable implements CollectionManagementService

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.
Field Summary
protected StringbasePath
protected Collectioncollection
Constructor Summary
CollectionManagementServiceImpl(String basePath)
Creates a new CollectionManager service
Method Summary
CollectioncreateCollection(String name)
Creates a simple collection with a basic default configuration.
StringgetName()
Returns the name of the Service
StringgetVersion()
Returns the version of the Service
voidremoveCollection(String name)
Removes the named collection from the system.
voidsetCollection(Collection col)
Provides a reference to the XML:DB collection instance that this service is associated with.

Field Detail

basePath

protected String basePath

collection

protected Collection collection

Constructor Detail

CollectionManagementServiceImpl

public CollectionManagementServiceImpl(String basePath)
Creates a new CollectionManager service

Method Detail

createCollection

public Collection createCollection(String name)
Creates a simple collection with a basic default configuration. More complex configuration requires using a proprietary interface

getName

public String getName()
Returns the name of the Service

Returns: the name of the Service

getVersion

public String getVersion()
Returns the version of the Service

Returns: the version of the Service

removeCollection

public void removeCollection(String name)
Removes the named collection from the system.

setCollection

public void setCollection(Collection col)
Provides a reference to the XML:DB collection instance that this service is associated with.

Parameters: col the XML:DB collection instance associated with this Service