|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface describes a XML collection of XML documents.
Note:
This object is likely to use resources that can be released using the
close()
method.
Method Summary | |
void |
close()
Closes this XMLCollection. |
boolean |
containsDocument(java.lang.String documentID)
Checks if a named XML document exists in this XML collection. |
XMLConnection |
getConnection()
Retrieves the XMLConnection object that produced this XMLCollection. |
java.lang.String |
getDescription()
Retrieves the description of the XML collection. |
XMLDocument |
getDocument(java.lang.String documentID)
Retrieves an XML document in the XML collection. |
long |
getDocumentCount()
Retrieves the XML collection size (number of documents). |
XMLDocumentFiler |
getDocumentFiler()
Creates a "filer" object that can be used to insert a new XML document into the XML collection. |
java.util.List |
getIdentifierList()
Returns a list of documents identifiers available in the XML collection. |
java.lang.String |
getName()
Retrieves the unique name of the XML collection. |
boolean |
isReadOnly()
Returns true if the XML collection is read-only mode. |
int |
removeAllDocuments()
Removes all XML documents from the XML collection. |
boolean |
removeDocument(java.lang.String documentID)
Removes the named XML document from the XML collection. |
boolean |
renameDocument(java.lang.String oldID,
java.lang.String newID)
Renames a document. |
void |
setDescription(java.lang.String description)
Sets the description of the XML collection. |
void |
setReadOnly(boolean readOnly)
Changes the read-only mode for this XML collection. |
Methods inherited from interface org.xquark.xml.xdbc.Configurable |
getFeature, getFeatureList, getProperty, getPropertyList, setFeature, setProperty |
Method Detail |
public void close() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public java.lang.String getName() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public java.lang.String getDescription() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public void setDescription(java.lang.String description) throws XMLDBCException
description
- the description of the XML collection.
XMLDBCException
- if a data source access error occurs.public long getDocumentCount() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public boolean isReadOnly() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public void setReadOnly(boolean readOnly) throws XMLDBCException
readOnly
- true to change mode to read-only, false otherwise.
XMLDBCException
- if a data source access error occurs.public XMLConnection getConnection() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public XMLDocumentFiler getDocumentFiler() throws XMLDBCException
Warning: Asuming an XMLConnection
is monothread,
being able to create multiple XMLDocumentFiler does not mean one can use
XMLDocumentFiler created from the same XMLCollection in different
threads.
XMLDBCException
- if a database access error occurs.public XMLDocument getDocument(java.lang.String documentID) throws XMLDBCException
Note: implementations may accept for performance reasons the XMLDocument creation even if the document does not really exist. In that situation, an exception will be raised on subsequent operations.
documentID
- the string used to identify the XML document in the collection.
XMLDBCException
- if a data source access error occurs.public boolean removeDocument(java.lang.String documentID) throws XMLDBCException
documentID
- the string used to identify the XML document in the collection.
XMLDBCException
- if a data source access error occurs.public int removeAllDocuments() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public boolean containsDocument(java.lang.String documentID) throws XMLDBCException
documentID
- the string used to identify the XML document in the collection.
XMLDBCException
- if a data source access error occurs.public boolean renameDocument(java.lang.String oldID, java.lang.String newID) throws XMLDBCException
oldID
- the old string used to identify the XML document in the collection.newID
- the new string used to identify the XML document in the collection.
XMLDBCException
- if an error or operation not supported.public java.util.List getIdentifierList() throws XMLDBCException
XMLDBCException
- if data source access error occurs or operation not supported.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |