org.xmldb.api.sdk
public abstract class SimpleCollection extends SimpleConfigurable implements Collection
Field Summary | |
---|---|
protected boolean | isOpen |
protected Hashtable | services |
Constructor Summary | |
---|---|
SimpleCollection() |
Method Summary | |
---|---|
protected void | checkOpen()
Throws an exception if the collection is not open. |
void | close()
Releases all resources consumed by the Collection .
|
String | createId()
Creates a new unique ID within the context of the Collection
|
Resource | createResource(String id, String type)
Creates a new empty Resource with the provided id.
|
Collection | getChildCollection(String name)
Default behaviour for a non-hierarchical implementation
|
int | getChildCollectionCount()
Default behaviour for a non-hierarchical implementation
|
String | getName()
Returns the name associated with the Configurable object.
|
Collection | getParentCollection()
Default behaviour for a non-hierarchical implementation
|
Resource | getResource(String id)
Retrieves a Resource from the database. |
int | getResourceCount()
Returns the number of resources currently stored in this collection or 0
if the collection is empty.
|
Service | getService(String name, String version)
Get a Service instance based on the name and version.
|
Service[] | getServices()
Returns the list of Services supported by this Collection.
|
boolean | isOpen() |
String[] | listChildCollections()
Default behaviour for a non-hierarchical implementation
|
String[] | listResources()
Returns a list of the ids for all resources stored in the collection.
|
void | registerService(Service service)
Registers a new Service with this Collection.
|
void | removeResource(Resource res)
Removes the Resource from the database.
|
void | storeResource(Resource res)
Stores the provided resource into the database. |
Collection
.
The close
method must
always be called when use of a Collection
is complete.
Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
Collection
Returns: the created id as a string.
Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
Resource
with the provided id.
The type of Resource
returned is determined by the type
parameter. The XML:DB API currently
defines "XMLResource" and "BinaryResource" as valid resource types.
The id
provided must be unique within the scope of the
collection. If
id
is null or its value is empty then an id is generated by
calling createId()
. The
Resource
created is not stored to the database until
storeResource()
is called.
Parameters: id the unique id to associate with the created Resource
. type the Resource
type to create.
Returns: an empty Resource
instance.
Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
ErrorCodes.UNKNOWN_RESOURCE_TYPE
if the type
parameter is not a known Resource
type.
Parameters: name the name of the child collection to retrieve.
Returns: the requested child collection or null if it couldn't be found.
Returns: the number of child collections.
Returns: the name of the object.
Returns: the parent Collection
instance.
Resource
from the database. If the
Resource
could not be
located a null value will be returned.
Parameters: id the unique id for the requested resource.
Returns: The retrieved Resource
instance.
Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
Returns: the number of resource in the collection.
Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
Parameters: name The Service instance to retrieve version The version of the service to retrieve.
Returns: The Service instance or null if no service was found.
Returns: A list of supported Services
Returns: an array containing collection names for all child collections.
Returns: a string array containing the names for all
Resource
s in the collection.
Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
Parameters: service Description of Parameter
Throws: XMLDBException
Resource
from the database.
Parameters: res the resource to remove.
Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
ErrorCodes.INVALID_RESOURCE
if the Resource
is
not valid.
ErrorCodes.NO_SUCH_RESOURCE
if the Resource
is
not known to this Collection
.
Parameters: res the resource to store in the database.
Throws: XMLDBException with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
ErrorCodes.INVALID_RESOURCE
if the Resource
is
not valid.