|
dbXML API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.xmldb.api.sdk.SimpleConfigurable | +--org.xmldb.api.sdk.SimpleCollection | +--org.xmldb.api.reference.CollectionImpl
A Collection
is implemented as a directory in the file system.
Constructor Summary | |
CollectionImpl(java.lang.String path)
|
Method Summary | |
void |
close()
Releases all resources consumed by the Collection . |
java.lang.String |
createId()
Creates a new unique ID within the context of the Collection |
Resource |
createResource(java.lang.String id,
java.lang.String type)
Creates a new empty Resource with the provided id. |
Collection |
getChildCollection(java.lang.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 . |
java.lang.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(java.lang.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. |
java.lang.String[] |
listChildCollections()
Returns a list of collection names naming all child collections of the current collection. |
java.lang.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. |
Methods inherited from class org.xmldb.api.sdk.SimpleCollection |
getService, getServices, registerService |
Methods inherited from class org.xmldb.api.sdk.SimpleConfigurable |
getProperty, setProperty |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.xmldb.api.base.Collection |
isOpen |
Methods inherited from interface org.xmldb.api.base.Configurable |
getProperty, setProperty |
Constructor Detail |
public CollectionImpl(java.lang.String path) throws java.io.FileNotFoundException
Method Detail |
public java.lang.String getName() throws XMLDBException
getName
in class SimpleCollection
public Collection getParentCollection() throws XMLDBException
getParentCollection
in class SimpleCollection
Collection
instance.public int getChildCollectionCount() throws XMLDBException
Collection
.getChildCollectionCount
in class SimpleCollection
public java.lang.String[] listChildCollections() throws XMLDBException
listChildCollections
in class SimpleCollection
public Collection getChildCollection(java.lang.String name) throws XMLDBException
Collection
instance for the requested child collection
if it exists.getChildCollection
in class SimpleCollection
name
- the name of the child collection to retrieve.public int getResourceCount() throws XMLDBException
getResourceCount
in class SimpleCollection
public java.lang.String[] listResources() throws XMLDBException
listResources
in class SimpleCollection
Resource
s in the collection.public Resource createResource(java.lang.String id, java.lang.String type) throws XMLDBException
Resource
with the provided id.createResource
in class SimpleCollection
id
- the unique id to associate with the created Resource
.type
- the Resource
type to create.Resource
instance.public void removeResource(Resource res) throws XMLDBException
Resource
from the database.removeResource
in class SimpleCollection
res
- the resource to remove.public void storeResource(Resource res) throws XMLDBException
storeResource
in class SimpleCollection
res
- the resource to store in the database.public Resource getResource(java.lang.String id) throws XMLDBException
Resource
from the database.getResource
in class SimpleCollection
id
- the unique id for the requested resource.Resource
instance.public java.lang.String createId() throws XMLDBException
Collection
createId
in class SimpleCollection
public void close() throws XMLDBException
Collection
.close
in class SimpleCollection
org.xmldb.api.sdk.SimpleCollection
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
|
dbXML API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |