|
dbXML API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.dbxml.core.CollectionManager | +--org.dbxml.core.Collection
Collection represents a collection of Documents maintains links to the Filer storage implementation, the Indexes, and any XMLObjects that may be associated with the Collection.
Constructor Summary | |
Collection(Collection collection)
|
Method Summary | |
boolean |
close()
close closes the DBObject |
boolean |
create()
create creates a new DBObject and any associated resources for the new DBObject, such as disk files, etc. |
Indexer |
createIndexer(org.dbxml.server.Configuration config)
createIndexer creates a new Indexer object and any associated system resources that the Indexer will need. |
Key |
createNewOID()
createNewOID allocates a new Object ID to be used as a Key in the Collection. |
XMLObject |
createXMLObject(org.dbxml.server.Configuration config)
createXMLObject creates a new XMLObject object and any associated system resources that the XMLObject will need. |
boolean |
drop()
drop instructs the DBObjectimplementation to remove itself from existence. |
boolean |
dropIndexer(Indexer index)
dropIndexer physically removes the specified Indexer and any associated system resources that the Indexer uses. |
boolean |
dropXMLObject(XMLObject xmlObject)
dropXMLObject physically removes the specified XMLObject and any associated system resources that the XMLObject uses. |
boolean |
exists()
exists returns whether or not a physical representation of this DBObject actually exists. |
void |
flushSymbolTable()
|
java.lang.String |
getCanonicalDocumentName(Key key)
getCanonicalDocumentName returns the canonical name for the specified Key in relation to this Collection. |
java.lang.String |
getCanonicalName()
getCanonicalName returns the canonical name for this Object. |
java.io.File |
getCollectionRoot()
|
Container |
getContainer(java.lang.Object docKey)
getContainer retrieves a Container from the Collection. |
Database |
getDatabase()
getDatabase returns the Database owner for this Collection. |
org.w3c.dom.Document |
getDocument(java.lang.Object docKey)
getDocument retrieves a Document by Key. |
long |
getDocumentCount()
getDocumentCount returns the count of Documents being maintained by this Collection. |
DocumentSet |
getDocumentSet()
getDocumentSet returns the set of Documents being maintained by this Collection. |
Filer |
getFiler()
getFiler returns the low-level Filer instances underlying the Collection instance. |
Indexer |
getIndexer(java.lang.String name)
getIndexer retrieves an Indexer by name. |
IndexManager |
getIndexManager()
return the IndexManager being used by this Collection. |
java.lang.String |
getName()
|
XMLSerializable |
getObject(java.lang.Object key)
getObject instantiates and returns an XMLSerializable object based on the provided Key. |
Collection |
getParentCollection()
getParentCollection returns the parent Collection of this Collection. |
QueryEngine |
getQueryEngine()
getQueryEngine returns the Database's Query Engine |
SymbolTable |
getSymbols()
getSymbols returns the SymbolTable in use by this Collection. |
SystemCollection |
getSystemCollection()
getSystemCollection returns the System Collection. |
XMLObject |
getXMLObject(java.lang.String name)
getXMLObject retrieves an XMLObject by name. |
XMLObjectManager |
getXMLObjectManager()
getXMLObjectManager returns the Object's XMLObjectManager. |
Key |
insertDocument(org.w3c.dom.Document document)
insertDocument inserts a new Document into a dbXML Collection. |
void |
insertDocument(java.lang.Object docKey,
org.w3c.dom.Document document)
insertDocument inserts a new Document into a dbXML Collection. |
void |
insertObject(java.lang.String key,
XMLSerializable obj)
insertObject inserts an XMLSerializable object into the Collection based on the specified Key. |
Key |
insertObject(XMLSerializable obj)
insertObject inserts an XMLSerializable object into the Collection and returns a newly generated Key. |
boolean |
isOpened()
isOpened returns whether or not the DBObject is opened for business. |
java.lang.String[] |
listDocuments()
listDocuments returns a list of all document keys stored by this collection. |
java.lang.String[] |
listIndexers()
listIndexers returns a list of the currently registered Indexers as an array of String. |
java.lang.String[] |
listXMLObjects()
listXMLObjects returns a list of the currently registered XMLObjects as an array of String. |
boolean |
open()
open opens the DBObject |
NodeSet |
queryCollection(java.lang.String style,
java.lang.String query,
NamespaceMap nsMap)
queryCollection performs a query against the current collection using the specified style and query String. |
NodeSet |
queryDocument(java.lang.String style,
java.lang.String query,
NamespaceMap nsMap,
java.lang.Object key)
queryDocument performs a query against a single Document using the specified style, query string, and Document ID. |
void |
remove(java.lang.Object key)
remove removes an object from the Collection based on its Key, regardless of it's type. |
void |
setConfig(org.dbxml.server.Configuration config)
|
void |
setDocument(java.lang.Object docKey,
org.w3c.dom.Document document)
setDocument overwrites/updates an existing Document in a dbXML Collection. |
void |
setObject(java.lang.Object key,
XMLSerializable obj)
setObject sets an XMLSerializable object in the Collection based on the provided Key. |
Methods inherited from class org.dbxml.core.CollectionManager |
createCollection, dispose, dropCollection, getCollection, getConfig, listCollections |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.dbxml.server.Configurable |
getConfig |
Constructor Detail |
public Collection(Collection collection)
Method Detail |
public void setConfig(org.dbxml.server.Configuration config) throws org.dbxml.server.dbXMLException
setConfig
in interface org.dbxml.server.Configurable
setConfig
in class CollectionManager
public final java.lang.String getName()
getName
in interface org.dbxml.server.Named
public final java.io.File getCollectionRoot()
public final Collection getParentCollection() throws DBException
public Database getDatabase()
public SystemCollection getSystemCollection() throws DBException
public QueryEngine getQueryEngine() throws DBException
public final Indexer getIndexer(java.lang.String name) throws DBException
name
- The Indexer namepublic final java.lang.String[] listIndexers() throws DBException
public final boolean dropIndexer(Indexer index) throws DBException
index
- The Indexer to droppublic final Indexer createIndexer(org.dbxml.server.Configuration config) throws DBException
config
- The Indexer's configurationpublic final Filer getFiler()
public final IndexManager getIndexManager() throws DBException
public final XMLObjectManager getXMLObjectManager() throws DBException
public final XMLObject getXMLObject(java.lang.String name) throws DBException
name
- The XMLObject's namepublic java.lang.String[] listXMLObjects() throws DBException
public final boolean dropXMLObject(XMLObject xmlObject) throws DBException
xmlObject
- The XMLObject to droppublic final XMLObject createXMLObject(org.dbxml.server.Configuration config) throws DBException
config
- The XMLObject's configurationpublic final SymbolTable getSymbols() throws DBException
public final java.lang.String getCanonicalName()
public final java.lang.String getCanonicalDocumentName(Key key)
key
- The Keypublic final boolean open() throws DBException
DBObject
open
in interface DBObject
org.dbxml.core.DBObject
public boolean isOpened() throws DBException
DBObject
isOpened
in interface DBObject
org.dbxml.core.DBObject
public boolean exists() throws DBException
DBObject
exists
in interface DBObject
org.dbxml.core.DBObject
public boolean close() throws DBException
DBObject
close
in interface DBObject
org.dbxml.core.DBObject
public boolean create() throws DBException
DBObject
create
in interface DBObject
org.dbxml.core.DBObject
public boolean drop() throws DBException
DBObject
drop
in interface DBObject
org.dbxml.core.DBObject
public final Key createNewOID()
public final void flushSymbolTable() throws DBException
public final Key insertDocument(org.w3c.dom.Document document) throws DBException
document
- The Documentpublic final void insertDocument(java.lang.Object docKey, org.w3c.dom.Document document) throws DBException
docKey
- The document Keyvalue
- The Documentpublic final void setDocument(java.lang.Object docKey, org.w3c.dom.Document document) throws DBException
docKey
- The Document Keydocument
- The Documentpublic final void remove(java.lang.Object key) throws DBException
key
- The Object's Keypublic final org.w3c.dom.Document getDocument(java.lang.Object docKey) throws DBException
docKey
- The Document Keypublic final Container getContainer(java.lang.Object docKey) throws DBException
docKey
- The Document Keypublic final XMLSerializable getObject(java.lang.Object key) throws DBException
key
- The Document Keypublic final void setObject(java.lang.Object key, XMLSerializable obj) throws DBException
key
- The Key to useobj
- The Object to setpublic final Key insertObject(XMLSerializable obj) throws DBException
obj
- The Object to insertpublic final void insertObject(java.lang.String key, XMLSerializable obj) throws DBException
key
- The Key to useobj
- The Object to insertpublic final NodeSet queryCollection(java.lang.String style, java.lang.String query, NamespaceMap nsMap) throws DBException
style
- The query style to use (ex: XPath)query
- The query to executensMap
- The namespace Map (if any)public final NodeSet queryDocument(java.lang.String style, java.lang.String query, NamespaceMap nsMap, java.lang.Object key) throws DBException
style
- The query style to use (ex: XPath)query
- The query to executensMap
- The namespace Map (if any)key
- The Document to querypublic final DocumentSet getDocumentSet() throws DBException
public final java.lang.String[] listDocuments() throws DBException
public final long getDocumentCount() throws DBException
|
dbXML API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |