Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.xmldb.api.reference

Class CollectionImpl

Implemented Interfaces:
Collection, Configurable
public class CollectionImpl
extends SimpleCollection
A Collection is implemented as a directory in the file system.

Field Summary

protected File
collection

Fields inherited from class org.xmldb.api.sdk.SimpleCollection

isOpen, services

Constructor Summary

CollectionImpl(String path)

Method Summary

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)
Returns a Collection instance for the requested child collection if it exists.
int
getChildCollectionCount()
Returns the number of child collections under this Collection.
String
getName()
Returns the name of the collection
Collection
getParentCollection()
Returns the parent collection for this collection or null if no parent collection exists.
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.
String[]
listChildCollections()
Returns a list of collection names naming all child collections of the current collection.
String[]
listResources()
Returns a list of the ids for all resources stored in the collection.
void
removeResource(Resource res)
Removes the Resource from the database.
void
storeResource(Resource res)
Stores the provided resource into the database.
protected void
validateResource(Resource res)
Makes sure the resource is valid.

Methods inherited from class org.xmldb.api.sdk.SimpleCollection

checkOpen, close, createId, createResource, getChildCollection, getChildCollectionCount, getName, getParentCollection, getResource, getResourceCount, getService, getServices, isOpen, listChildCollections, listResources, registerService, removeResource, storeResource

Methods inherited from class org.xmldb.api.sdk.SimpleConfigurable

getProperty, setProperty

Field Details

collection

protected File collection

Constructor Details

CollectionImpl

public CollectionImpl(String path)
            throws FileNotFoundException,
                   XMLDBException

Method Details

close

public void close()
            throws XMLDBException
Releases all resources consumed by the Collection.
Specified by:
close in interface Collection
Overrides:
close in interface SimpleCollection

createId

public String createId()
            throws XMLDBException
Creates a new unique ID within the context of the Collection
Specified by:
createId in interface Collection
Overrides:
createId in interface SimpleCollection
Returns:
the created id as a string.

createResource

public Resource createResource(String id,
                               String type)
            throws XMLDBException
Creates a new empty Resource with the provided id.
Specified by:
createResource in interface Collection
Overrides:
createResource in interface SimpleCollection
Parameters:
id - the unique id to associate with the created Resource.
type - the Resource type to create.
Returns:
an empty Resource instance.

getChildCollection

public Collection getChildCollection(String name)
            throws XMLDBException
Returns a Collection instance for the requested child collection if it exists.
Specified by:
getChildCollection in interface Collection
Overrides:
getChildCollection in interface SimpleCollection
Parameters:
name - the name of the child collection to retrieve.
Returns:
the requested child collection or null if it couldn't be found.

getChildCollectionCount

public int getChildCollectionCount()
            throws XMLDBException
Returns the number of child collections under this Collection.
Specified by:
getChildCollectionCount in interface Collection
Overrides:
getChildCollectionCount in interface SimpleCollection
Returns:
the number of child collections.

getName

public String getName()
            throws XMLDBException
Returns the name of the collection
Specified by:
getName in interface Collection
Overrides:
getName in interface SimpleCollection
Returns:
the name of the object.

getParentCollection

public Collection getParentCollection()
            throws XMLDBException
Returns the parent collection for this collection or null if no parent collection exists.
Specified by:
getParentCollection in interface Collection
Overrides:
getParentCollection in interface SimpleCollection
Returns:
the parent Collection instance.

getResource

public Resource getResource(String id)
            throws XMLDBException
Retrieves a Resource from the database.
Specified by:
getResource in interface Collection
Overrides:
getResource in interface SimpleCollection
Parameters:
id - the unique id for the requested resource.
Returns:
The retrieved Resource instance.

getResourceCount

public int getResourceCount()
            throws XMLDBException
Returns the number of resources currently stored in this collection or 0 if the collection is empty.
Specified by:
getResourceCount in interface Collection
Overrides:
getResourceCount in interface SimpleCollection
Returns:
the number of resources in the collection.

listChildCollections

public String[] listChildCollections()
            throws XMLDBException
Returns a list of collection names naming all child collections of the current collection.
Specified by:
listChildCollections in interface Collection
Overrides:
listChildCollections in interface SimpleCollection
Returns:
an array containing collection names for all child collections.

listResources

public String[] listResources()
            throws XMLDBException
Returns a list of the ids for all resources stored in the collection.
Specified by:
listResources in interface Collection
Overrides:
listResources in interface SimpleCollection
Returns:
a string array containing the names for all Resources in the collection.

removeResource

public void removeResource(Resource res)
            throws XMLDBException
Removes the Resource from the database.
Specified by:
removeResource in interface Collection
Overrides:
removeResource in interface SimpleCollection
Parameters:
res - the resource to remove.

storeResource

public void storeResource(Resource res)
            throws XMLDBException
Stores the provided resource into the database.
Specified by:
storeResource in interface Collection
Overrides:
storeResource in interface SimpleCollection
Parameters:
res - the resource to store in the database.

validateResource

protected void validateResource(Resource res)
            throws XMLDBException
Makes sure the resource is valid.

Overview Package Tree Index Deprecated About