|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
CollectionClient is the standard interface for working with a dbXML Collection in a client/server fashion.
Field Summary | |
static int |
TYPE_DOCUMENTS
|
static int |
TYPE_VALUES
|
Method Summary | |
CollectionClient |
createCollection(java.lang.String path,
org.w3c.dom.Document configuration)
createCollection creates a new Collection object and any associated system resources that the Collection will need. |
java.lang.String |
createExtension(org.w3c.dom.Document configuration)
createExtension creates a new Extension object and any associated system resources that the Extension will need. |
java.lang.String |
createIndexer(org.w3c.dom.Document configuration)
createIndexer creates a new Indexer object and any associated system resources that the Indexer will need. |
java.lang.String |
createKey()
createKey creates a new Collection unique Key. |
java.lang.String |
createTrigger(org.w3c.dom.Document configuration)
createTrigger creates a new Trigger object and any associated system resources that the Trigger will need. |
boolean |
dropCollection(java.lang.String name)
dropCollection physically removes the specified Collection and any associated system resources that the Collection uses. |
boolean |
dropExtension(java.lang.String name)
dropExtension physically removes the specified Extension and any associated system resources that the Extension uses. |
boolean |
dropIndexer(java.lang.String name)
dropIndexer physically removes the specified Indexer and any associated system resources that the Indexer uses. |
boolean |
dropTrigger(java.lang.String name)
dropTrigger physically removes the specified Trigger and any associated system resources that the Trigger uses. |
java.lang.String |
getCanonicalName()
getCanonicalName returns the canonical name for this Object. |
dbXMLClient |
getClient()
getClient returns the dbXMLClient instance for this CollectionClient. |
CollectionClient |
getCollection(java.lang.String name)
getCollection retrieves a Collection by name. |
int |
getCollectionType()
getCollectionType returns the type of Objects that the Collection is allowed to store. |
ContentClient |
getContent(java.lang.String key)
getContent returns a ContentClient instance by Key. |
CollectionClient |
getDatabase()
getDatabase returns the Database owner for this Collection. |
org.w3c.dom.Document |
getDocument(java.lang.String docKey)
getDocument retrieves a Document by Key. |
java.lang.String |
getDocumentAsText(java.lang.String docKey)
getDocumentAsText retrieves a Document by Key. |
java.lang.String |
getExtension(java.lang.String name)
getExtension retrieves an Extension by name. |
long |
getKeyCount()
getKeyCount returns the count of Objects being maintained by this Collection. |
java.lang.String |
getName()
getName returns the name for this Object. |
CollectionClient |
getParentCollection()
getParentCollection returns the parent Collection of this Collection. |
CollectionClient |
getSystemCollection()
getSystemCollection returns the System Collection. |
byte[] |
getValue(java.lang.String key)
getValue retrieves a binary Record from the Collection. |
java.lang.String |
insertDocument(org.w3c.dom.Document document)
insertDocument inserts a new Document into a dbXML Collection. |
java.lang.String |
insertDocumentAsText(java.lang.String document)
insertDocumentAsText inserts a new Document into a dbXML Collection. |
java.lang.String |
insertValue(byte[] value)
insertValue stores a binary Record in the Collection and returns a newly generated Key. |
java.lang.String[] |
listCollections()
listCollections retrieves a list of Collections as an array of Strings. |
java.lang.String[] |
listExtensions()
listExtensions returns a list of the currently registered Extensions as an array of String. |
java.lang.String[] |
listIndexers()
listIndexers returns a list of the currently registered Indexers as an array of String. |
java.lang.String[] |
listKeys()
listKeys returns a list of all Object keys stored by this collection. |
java.lang.String[] |
listTriggers()
listTriggers returns a list of the currently registered Triggers as an array of String. |
ResultSetClient |
queryCollection(java.lang.String style,
java.lang.String query,
java.util.Map nsMap)
queryCollection performs a query against the current Collection using the specified style and query String. |
ResultSetClient |
queryDocument(java.lang.String style,
java.lang.String query,
java.util.Map nsMap,
java.lang.String key)
queryDocument performs a query against a single Document using the specified style, query string, and Document ID. |
void |
remove(java.lang.String docKey)
remove removes an object from the Collection based on its Key, regardless of its type. |
void |
setDocument(java.lang.String docKey,
org.w3c.dom.Document document)
setDocument overwrites/updates an existing Document in a dbXML Collection. |
void |
setDocumentAsText(java.lang.String docKey,
java.lang.String document)
setDocumentAsText overwrites/updates an existing Document in a dbXML Collection. |
void |
setValue(java.lang.String key,
byte[] value)
setValue stores a binary Record in the Collection. |
Field Detail |
public static final int TYPE_DOCUMENTS
public static final int TYPE_VALUES
Method Detail |
public dbXMLClient getClient()
public java.lang.String getName() throws dbXMLException
dbXMLException
public int getCollectionType() throws dbXMLException
dbXMLException
public java.lang.String getCanonicalName() throws dbXMLException
dbXMLException
public CollectionClient getParentCollection() throws dbXMLException
dbXMLException
public CollectionClient getDatabase() throws dbXMLException
dbXMLException
public CollectionClient getSystemCollection() throws dbXMLException
dbXMLException
public CollectionClient getCollection(java.lang.String name) throws dbXMLException
dbXMLException
public CollectionClient createCollection(java.lang.String path, org.w3c.dom.Document configuration) throws dbXMLException
path
- The relative path of the Collectionconfiguration
- The Collection's configuration
dbXMLException
public java.lang.String[] listCollections() throws dbXMLException
dbXMLException
public boolean dropCollection(java.lang.String name) throws dbXMLException
dbXMLException
public java.lang.String createTrigger(org.w3c.dom.Document configuration) throws dbXMLException
configuration
- The Trigger's configuration
dbXMLException
public boolean dropTrigger(java.lang.String name) throws dbXMLException
name
- The Trigger to drop
dbXMLException
public java.lang.String[] listTriggers() throws dbXMLException
dbXMLException
public java.lang.String createIndexer(org.w3c.dom.Document configuration) throws dbXMLException
configuration
- The Indexer's configuration
dbXMLException
public boolean dropIndexer(java.lang.String name) throws dbXMLException
name
- The Indexer to drop
dbXMLException
public java.lang.String[] listIndexers() throws dbXMLException
dbXMLException
public java.lang.String getExtension(java.lang.String name) throws dbXMLException
name
- The Extension's name
dbXMLException
public java.lang.String createExtension(org.w3c.dom.Document configuration) throws dbXMLException
configuration
- The Extension's configuration
dbXMLException
public java.lang.String[] listExtensions() throws dbXMLException
dbXMLException
public boolean dropExtension(java.lang.String name) throws dbXMLException
name
- The Extension to drop
dbXMLException
public java.lang.String createKey() throws dbXMLException
dbXMLException
public org.w3c.dom.Document getDocument(java.lang.String docKey) throws dbXMLException
docKey
- The Document Key
dbXMLException
public java.lang.String getDocumentAsText(java.lang.String docKey) throws dbXMLException
docKey
- The Document Key
dbXMLException
public ContentClient getContent(java.lang.String key) throws dbXMLException
key
- The Content Key
dbXMLException
public java.lang.String insertDocument(org.w3c.dom.Document document) throws dbXMLException
document
- The Document
dbXMLException
public java.lang.String insertDocumentAsText(java.lang.String document) throws dbXMLException
document
- The Document
dbXMLException
public void setDocument(java.lang.String docKey, org.w3c.dom.Document document) throws dbXMLException
docKey
- The Document Keydocument
- The Document
dbXMLException
public void setDocumentAsText(java.lang.String docKey, java.lang.String document) throws dbXMLException
docKey
- The Document Keydocument
- The Document
dbXMLException
public void remove(java.lang.String docKey) throws dbXMLException
dbXMLException
public java.lang.String[] listKeys() throws dbXMLException
dbXMLException
public long getKeyCount() throws dbXMLException
dbXMLException
public java.lang.String insertValue(byte[] value) throws dbXMLException
value
- The Value to store
dbXMLException
public void setValue(java.lang.String key, byte[] value) throws dbXMLException
key
- The Key to usevalue
- The Value to store
dbXMLException
public byte[] getValue(java.lang.String key) throws dbXMLException
key
- The Record's Key
dbXMLException
public ResultSetClient queryCollection(java.lang.String style, java.lang.String query, java.util.Map nsMap) throws dbXMLException
style
- The query style to use (ex: XPath)query
- The query to executensMap
- The namespace Map (if any)
dbXMLException
public ResultSetClient queryDocument(java.lang.String style, java.lang.String query, java.util.Map nsMap, java.lang.String key) throws dbXMLException
style
- The query style to use (ex: XPath)query
- The query to executensMap
- The namespace Map (if any)key
- The Document to query
dbXMLException
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |