dbXML API

Uses of Class
com.dbxml.db.core.data.Key

Packages that use Key
com.dbxml.db.common.adapters Defines a set of Adapter classes that allow dbXML to persist objects other than dbXML DocumentTable instances. 
com.dbxml.db.common.btree Defines the dbXML BTree implementation as well as the low-level Paged file system. 
com.dbxml.db.common.filers Defines the standard dbXML Filer implementations which include MemFiler and FSFiler. 
com.dbxml.db.common.fulltext Defines the dbXML Full Text Indexer and a basic QueryResolver for Full Text retrieval. 
com.dbxml.db.common.indexers Defines the dbXML standard Indexer implementations which consist of NameIndexer and ValueIndexer. 
com.dbxml.db.common.query This package implements the common base functionality for Query Resolver implementations. 
com.dbxml.db.common.scripting Defines the dbXML Scripting package. 
com.dbxml.db.common.xpath This package implements the dbXML XPath query resolver. 
com.dbxml.db.common.xslt This package implements the dbXML XSLT query resolver. 
com.dbxml.db.common.xupdate Defines several classes for dbXML XUpdate query processing. 
com.dbxml.db.core This is the top-level package for all dbXML Core functionality. 
com.dbxml.db.core.adapter Defines the Adapter interface as well as an abstract Adapter implementation that can be built from. 
com.dbxml.db.core.data Defines and Implements several basic data types and container interfaces, including Key, Value, DocumentSet and NodeSet. 
com.dbxml.db.core.filer Defines the dbXML Filer interfaces. 
com.dbxml.db.core.indexer Defines the dbXML Indexer interfaces  
com.dbxml.db.core.query Implements the dbXML QueryEngine and XPathQueryResolver. 
com.dbxml.db.core.trigger Defines the dbXML Trigger interface and implements TriggerManager, several Trigger-related Exceptions and a Simple Trigger implementation. 
com.dbxml.db.enterprise.dbfiler Defines the dbXML DBFiler class as well as a Connection pooling system. 
com.dbxml.db.enterprise.sync Implements the Extensions and Triggers required to perform seemless synchronization between servers. 
 

Uses of Key in com.dbxml.db.common.adapters
 

Methods in com.dbxml.db.common.adapters that return Key
 Key XMLSerializableAdapter.insertObject(Transaction tx, XMLSerializable obj)
          insertObject inserts an XMLSerializable object into the Collection and returns a newly generated Key.
 Key JAXBElementAdapter.insertObject(Transaction tx, javax.xml.bind.Element obj)
          insertObject inserts an JAXB Element object into the Collection and returns a newly generated Key.
 Key DOMAdapter.insertDocument(Transaction tx, org.w3c.dom.Document doc)
          insertDocument inserts a DOM Document into the Collection and returns a newly generated Key.
 

Uses of Key in com.dbxml.db.common.btree
 

Methods in com.dbxml.db.common.btree with parameters of type Key
 RecordMetaData BTreeFiler.getRecordMetaData(Transaction tx, Key key)
           
 Record BTreeFiler.readRecord(Transaction tx, Key key)
           
 boolean BTreeFiler.writeRecord(Transaction tx, Key key, Value value)
           
 boolean BTreeFiler.deleteRecord(Transaction tx, Key key)
           
 

Uses of Key in com.dbxml.db.common.filers
 

Methods in com.dbxml.db.common.filers with parameters of type Key
 RecordMetaData MemFiler.getRecordMetaData(Transaction tx, Key key)
           
 Record MemFiler.readRecord(Transaction tx, Key key)
           
 boolean MemFiler.writeRecord(Transaction tx, Key key, Value value)
           
 boolean MemFiler.deleteRecord(Transaction tx, Key key)
           
 RecordMetaData FSFiler.getRecordMetaData(Transaction tx, Key key)
           
 Record FSFiler.readRecord(Transaction tx, Key key)
           
 boolean FSFiler.writeRecord(Transaction tx, Key key, Value value)
           
 boolean FSFiler.deleteRecord(Transaction tx, Key key)
           
 

Uses of Key in com.dbxml.db.common.fulltext
 

Methods in com.dbxml.db.common.fulltext with parameters of type Key
 QueryBase FullTextQueryResolver.createQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
 void FullTextIndexer.remove(Transaction tx, java.lang.String value, Key key, int pos, int elemID, int attrID)
           
 void FullTextIndexer.add(Transaction tx, java.lang.String value, Key key, int pos, int elemID, int attrID)
           
 

Constructors in com.dbxml.db.common.fulltext with parameters of type Key
FullTextResultSet(Transaction tx, Collection context, Query query, Key[] keySet)
           
FullTextQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
 

Uses of Key in com.dbxml.db.common.indexers
 

Methods in com.dbxml.db.common.indexers with parameters of type Key
 void ValueIndexer.remove(Transaction tx, java.lang.String value, Key key, int pos, int elemID, int attrID)
           
 void ValueIndexer.add(Transaction tx, java.lang.String value, Key key, int pos, int elemID, int attrID)
           
 void NameIndexer.remove(Transaction tx, java.lang.String value, Key key, int pos, int elemID, int attrID)
           
 void NameIndexer.add(Transaction tx, java.lang.String value, Key key, int pos, int elemID, int attrID)
           
 

Uses of Key in com.dbxml.db.common.query
 

Methods in com.dbxml.db.common.query that return Key
 Key ResultSetBase.getResultKey()
           
 Key[] QueryBase.getKeySet()
           
 

Methods in com.dbxml.db.common.query with parameters of type Key
 Query QueryResolverBase.compileQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
 ResultSet QueryResolverBase.query(Transaction tx, Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
abstract  QueryBase QueryResolverBase.createQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
 

Constructors in com.dbxml.db.common.query with parameters of type Key
ResultSetBase(Transaction tx, Collection context, Query query, Key[] keySet)
           
QueryBase(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
 

Uses of Key in com.dbxml.db.common.scripting
 

Methods in com.dbxml.db.common.scripting with parameters of type Key
 java.lang.Object ScriptTrigger.beforeInsert(Transaction tx, Key key, java.lang.Object newObj)
           
 void ScriptTrigger.afterInsert(Transaction tx, Key key, java.lang.Object newObj)
           
 java.lang.Object ScriptTrigger.beforeUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
           
 void ScriptTrigger.afterUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
           
 void ScriptTrigger.beforeDelete(Transaction tx, Key key, java.lang.Object oldObj)
           
 void ScriptTrigger.afterDelete(Transaction tx, Key key, java.lang.Object oldObj)
           
 void ScriptTrigger.beforeGet(Transaction tx, Key key)
           
 void ScriptTrigger.afterGet(Transaction tx, Key key, java.lang.Object obj)
           
 

Uses of Key in com.dbxml.db.common.xpath
 

Methods in com.dbxml.db.common.xpath with parameters of type Key
 QueryBase XPathQueryResolver.createQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
 

Uses of Key in com.dbxml.db.common.xslt
 

Methods in com.dbxml.db.common.xslt with parameters of type Key
 QueryBase XSLTQueryResolver.createQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
 

Uses of Key in com.dbxml.db.common.xupdate
 

Methods in com.dbxml.db.common.xupdate with parameters of type Key
 QueryBase XUpdateQueryResolver.createQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
           
 

Uses of Key in com.dbxml.db.core
 

Methods in com.dbxml.db.core that return Key
 Key Container.getKey()
          getKey returns the Object Key.
 Key Collection.createNewOID()
          createNewOID allocates a new Object ID to be used as a Key in the Collection.
 Key Collection.insertDocument(Transaction tx, DocumentTable document)
          insertDocument inserts a new Document into a dbXML Collection.
 Key Collection.insertRecord(Transaction tx, Value value)
          insertRecord stores a binary Record in the Collection and returns a newly generated Key.
 Key[] Collection.listKeys(Transaction tx)
          listKeys returns a list of all object keys stored by this collection.
 

Methods in com.dbxml.db.core with parameters of type Key
 java.lang.String Collection.getCanonicalDocumentName(Key key)
          getCanonicalDocumentName returns the canonical name for the specified Key in relation to this Collection.
 java.lang.Object Cache.get(Collection col, Key key)
           
 Record Cache.getRecord(Collection col, Key key)
           
 DocumentTable Cache.getDocument(Collection col, Key key)
           
 void Cache.put(Collection col, Key key, java.lang.Object obj)
           
 void Cache.remove(Collection col, Key key)
           
 

Uses of Key in com.dbxml.db.core.adapter
 

Methods in com.dbxml.db.core.adapter that return Key
 Key[] SimpleAdapter.listKeys(Transaction tx)
           
 Key[] Adapter.listKeys(Transaction tx)
          listKeys returns a list of object keys stored managed by the Adapter.
 

Uses of Key in com.dbxml.db.core.data
 

Methods in com.dbxml.db.core.data that return Key
 Key RecordSet.getNextKey()
          getNextKey returns the next Record's Key, and skips the RecordSet ahead to the next Record.
 Key Record.getKey()
          getKey returns the Record's Key.
 Key EmptyRecordSet.getNextKey()
           
 

Constructors in com.dbxml.db.core.data with parameters of type Key
Record(Key key, Value value, RecordMetaData meta)
           
Record(Key key, Value value)
           
 

Uses of Key in com.dbxml.db.core.filer
 

Methods in com.dbxml.db.core.filer with parameters of type Key
 RecordMetaData Filer.getRecordMetaData(Transaction tx, Key key)
          getRecordMetaData returns metadata about the Record identified by the provided Key.
 Record Filer.readRecord(Transaction tx, Key key)
          readRecord returns a Record from the Filer based on the specified Key.
 boolean Filer.writeRecord(Transaction tx, Key key, Value value)
          writeRecord writes a Value to the Filer based on the specified Key.
 boolean Filer.deleteRecord(Transaction tx, Key key)
          deleteRecord removes a Record from the Filer based on the specified Key.
 

Uses of Key in com.dbxml.db.core.indexer
 

Methods in com.dbxml.db.core.indexer that return Key
 Key IndexMatch.getKey()
          getKey returns the Document Key for the IndexMatch.
 

Methods in com.dbxml.db.core.indexer with parameters of type Key
 void IndexManager.addDocument(Transaction tx, Key key, DocumentTable doc)
           
 void IndexManager.removeDocument(Transaction tx, Key key, DocumentTable doc)
           
 void Indexer.remove(Transaction tx, java.lang.String value, Key key, int pos, int elemID, int attrID)
          remove removes all references to the specified Key from the Indexer.
 void Indexer.add(Transaction tx, java.lang.String value, Key key, int pos, int elemID, int attrID)
          add adds a Document to the Indexer.
 

Constructors in com.dbxml.db.core.indexer with parameters of type Key
IndexMatch(Key key, int pos, int elem, int attr)
           
IndexMatch(Key key, int pos)
           
IndexMatch(Key key, IndexPattern pattern)
           
 

Uses of Key in com.dbxml.db.core.query
 

Methods in com.dbxml.db.core.query that return Key
 Key ResultSet.getResultKey()
          getResultKey return the Key for the current result in the cursor.
static Key[] QueryEngine.getUniqueKeys(IndexMatch[] matches)
          getUniqueKeys takes a set of IndexMatch objects and extracts all of its unique Keys in sorted order.
static Key[] QueryEngine.andKeySets(Key[][] keySets)
          andKeySets takes several sets of unique Keys and returns the ANDed set (elements that exist in all sets).
static Key[] QueryEngine.orKeySets(Key[][] keySets)
          orKeySets takes several sets of unique Keys and returns the ORed set (all unique elements).
 Key[] Query.getKeySet()
          getKeySet returns the initial set of Keys for this Query.
 

Methods in com.dbxml.db.core.query with parameters of type Key
 Query QueryResolver.compileQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
          compileQuery compiles a Query against the specified Collection context and returns the compiled Query.
 ResultSet QueryResolver.query(Transaction tx, Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)
          query compiles a Query against the specified Collection context and returns the query results.
 ResultSet QueryEngine.query(Transaction tx, Collection col, java.lang.String style, java.lang.String query, NamespaceMap nsMap, Key[] keys)
          query performs the specified query and returns a NodeSet with any possible results from that query.
 Query QueryEngine.compileQuery(Collection col, java.lang.String style, java.lang.String query, NamespaceMap nsMap, Key[] keys)
          compileQuery compiles a Query against the specified Collection context and returns the compiled Query.
static Key[] QueryEngine.andKeySets(Key[][] keySets)
          andKeySets takes several sets of unique Keys and returns the ANDed set (elements that exist in all sets).
static Key[] QueryEngine.orKeySets(Key[][] keySets)
          orKeySets takes several sets of unique Keys and returns the ORed set (all unique elements).
 

Uses of Key in com.dbxml.db.core.trigger
 

Methods in com.dbxml.db.core.trigger with parameters of type Key
 java.lang.Object TriggerManager.fireBeforeInsert(Transaction tx, Key key, java.lang.Object newObj)
          fireBeforeInsert fires beforeInsert events to all of the registered Triggers, unless a DBException is thrown.
 void TriggerManager.fireAfterInsert(Transaction tx, Key key, java.lang.Object newObj)
          fireAfterInsert fires afterInsert events to all of the registered Triggers, unless a DBException is thrown.
 java.lang.Object TriggerManager.fireBeforeUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
          fireBeforeUpdate fires beforeUpdate events to all of the registered Triggers, unless a DBException is thrown.
 void TriggerManager.fireAfterUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
          fireAfterUpdate fires afterUpdate events to all of the registered Triggers, unless a DBException is thrown.
 void TriggerManager.fireBeforeDelete(Transaction tx, Key key, java.lang.Object oldObj)
          fireBeforeDelete fires beforeDelete events to all of the registered Triggers, unless a DBException is thrown.
 void TriggerManager.fireAfterDelete(Transaction tx, Key key, java.lang.Object oldObj)
          fireAfterDelete fires afterDelete events to all of the registered Triggers, unless a DBException is thrown.
 void TriggerManager.fireBeforeGet(Transaction tx, Key key)
          fireBeforeGet fires beforeGet events to all of the registered Triggers, unless a DBException is thrown.
 void TriggerManager.fireAfterGet(Transaction tx, Key key, java.lang.Object obj)
          fireAfterGet fires afterGet events to all of the registered Triggers, unless a DBException is thrown.
 java.lang.Object Trigger.beforeInsert(Transaction tx, Key key, java.lang.Object newObj)
          beforeInsert is fired before a new Object is inserted into the Collection.
 void Trigger.afterInsert(Transaction tx, Key key, java.lang.Object newObj)
          afterInsert is fired after a new Object is inserted into the Collection.
 java.lang.Object Trigger.beforeUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
          beforeUpdate is fired before a Object is updated in the Collection.
 void Trigger.afterUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
          afterUpdate is fired after a Object is updated in the Collection.
 void Trigger.beforeDelete(Transaction tx, Key key, java.lang.Object oldObj)
          beforeDelete is fired before a Object is deleted from the Collection.
 void Trigger.afterDelete(Transaction tx, Key key, java.lang.Object oldObj)
          afterDelete is fired after a Object is deleted from the Collection.
 void Trigger.beforeGet(Transaction tx, Key key)
          beforeGet is fired before a Object is retrieved from the Collection.
 void Trigger.afterGet(Transaction tx, Key key, java.lang.Object obj)
          afterGet is fired after a Object is retrieved from the Collection, but before it is actually returned.
 java.lang.Object SimpleTrigger.beforeInsert(Transaction tx, Key key, java.lang.Object newObj)
           
 void SimpleTrigger.afterInsert(Transaction tx, Key key, java.lang.Object newObj)
           
 java.lang.Object SimpleTrigger.beforeUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
           
 void SimpleTrigger.afterUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
           
 void SimpleTrigger.beforeDelete(Transaction tx, Key key, java.lang.Object oldObj)
           
 void SimpleTrigger.afterDelete(Transaction tx, Key key, java.lang.Object oldObj)
           
 void SimpleTrigger.beforeGet(Transaction tx, Key key)
           
 void SimpleTrigger.afterGet(Transaction tx, Key key, java.lang.Object obj)
           
 

Uses of Key in com.dbxml.db.enterprise.dbfiler
 

Methods in com.dbxml.db.enterprise.dbfiler with parameters of type Key
 RecordMetaData DBFiler.getRecordMetaData(Transaction tx, Key key)
           
 Record DBFiler.readRecord(Transaction tx, Key key)
           
 boolean DBFiler.writeRecord(Transaction tx, Key key, Value value)
           
 boolean DBFiler.deleteRecord(Transaction tx, Key key)
           
 

Uses of Key in com.dbxml.db.enterprise.sync
 

Methods in com.dbxml.db.enterprise.sync with parameters of type Key
 void SyncTrigger.afterDelete(Transaction tx, Key key, java.lang.Object oldObj)
           
 void SyncTrigger.afterUpdate(Transaction tx, Key key, java.lang.Object oldObj, java.lang.Object newObj)
           
 void SyncTrigger.afterInsert(Transaction tx, Key key, java.lang.Object newObj)
           
 


dbXML API

Copyright (c) 2004 The dbXML Group