org.xmldb.api.reference.modules
Class CollectionManagementServiceImpl
java.lang.Object
|
+--org.xmldb.api.sdk.SimpleConfigurable
|
+--org.xmldb.api.reference.modules.CollectionManagementServiceImpl
- All Implemented Interfaces:
- CollectionManagementService, Configurable, Service
- 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.
Method Summary |
Collection |
createCollection(java.lang.String name)
Creates a simple collection with a basic default configuration. |
java.lang.String |
getName()
Returns the name of the Service |
java.lang.String |
getVersion()
Returns the version of the Service |
void |
removeCollection(java.lang.String name)
Removes the named collection from the system. |
void |
setCollection(Collection col)
Provides a reference to the XML:DB collection instance that this service
is associated with. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CollectionManagementServiceImpl
public CollectionManagementServiceImpl(java.lang.String basePath)
- Creates a new CollectionManager service
getName
public java.lang.String getName()
- Returns the name of the Service
- Specified by:
getName
in interface Service
- Returns:
- the name of the Service
getVersion
public java.lang.String getVersion()
- Returns the version of the Service
- Specified by:
getVersion
in interface Service
- Returns:
- the version of the Service
setCollection
public void setCollection(Collection col)
- Provides a reference to the XML:DB collection instance that this service
is associated with.
- Specified by:
setCollection
in interface Service
- Parameters:
col
- the XML:DB collection instance associated with this Service
createCollection
public Collection createCollection(java.lang.String name)
throws XMLDBException
- Creates a simple collection with a basic default configuration. More
complex configuration requires using a proprietary interface
- Specified by:
createCollection
in interface CollectionManagementService
- Following copied from interface:
org.xmldb.api.modules.CollectionManagementService
- Parameters:
name
- The name of the collection to create.- Returns:
- The created
Collection
instance. - Throws:
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
removeCollection
public void removeCollection(java.lang.String name)
throws XMLDBException
- Removes the named collection from the system.
- Specified by:
removeCollection
in interface CollectionManagementService
- Following copied from interface:
org.xmldb.api.modules.CollectionManagementService
- Parameters:
name
- The name of the collection to remove.- Throws:
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
Copyright (c) 2001 The XML:DB Initiative All rights reserved