dbXML API

## Uses of Class
org.dbxml.core.data.Key

Packages that use Key
org.dbxml.core: This is the top-level package for all dbXML Core functionality.
org.dbxml.core.data: Defines and Implements several basic data types and container interfaces, including Key, Value, DocumentSet and NodeSet.
org.dbxml.core.filer: Defines the dbXML Filer interface and implements several Filers, including BTreeFiler and HashFiler.
org.dbxml.core.indexer: Defines the dbXML Indexer interface and implements the IndexManager, and NodeIndexer classes.
org.dbxml.core.query: Implements the dbXML QueryEngine and XPathQueryResolver.
org.dbxml.core.xupdate: Defines several classes for dbXML XUpdate query processing.
org.dbxml.xml: Top level package for dbXML XML support, including DOM, SAX, Compression, and JAXP drivers.

Uses of Key in org.dbxml.core

Methods in org.dbxml.core that return Key
`Key` `Collection.createNewOID()` createNewOID allocates a new Object ID to be used as a Key in the Collection.
`Key` `Collection.insertDocument(org.w3c.dom.Document document)` insertDocument inserts a new Document into a dbXML Collection.
`Key` `Collection.insertObject(XMLSerializable obj)` insertObject inserts an XMLSerializable object into the Collection and returns a newly generated Key.
`Key` `Container.getKey()` getKey returns the Document Key.

Methods in org.dbxml.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.
`org.w3c.dom.Document` `DocumentCache.getDocument(Collection col, Key key)`
`void` `DocumentCache.putDocument(Collection col, Key key, byte[] bytes)`
`void` `DocumentCache.putDocument(Collection col, Key key, org.w3c.dom.Document doc)`
`void` `DocumentCache.removeDocument(Collection col, Key key)`

Uses of Key in org.dbxml.core.data

Methods in org.dbxml.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` `EmptyRecordSet.getNextKey()`
`Key` `Record.getKey()` getKey returns the Record's Key.

Constructors in org.dbxml.core.data with parameters of type Key
`Record(Key key, Value value, java.util.Map meta)`
`Record(Key key, Value value)`

Uses of Key in org.dbxml.core.filer

Methods in org.dbxml.core.filer that return Key
`Key` `Paged.Page.getKey()`

Methods in org.dbxml.core.filer with parameters of type Key
`Record` `BTreeFiler.readRecord(Key key)`
`boolean` `BTreeFiler.writeRecord(Key key, Value value)`
`boolean` `BTreeFiler.deleteRecord(Key key)`
`Record` `MemFiler.readRecord(Key key)` readRecord returns a Record from the Filer based on the specified Key.
`boolean` `MemFiler.writeRecord(Key key, Value value)` writeRecord writes a Value to the Filer based on the specified Key.
`boolean` `MemFiler.deleteRecord(Key key)` deleteRecord removes a Record from the Filer based on the specified Key.
`Record` `HashFiler.readRecord(Key key)`
`boolean` `HashFiler.writeRecord(Key key, Value value)`
`boolean` `HashFiler.deleteRecord(Key key)`
`Record` `Filer.readRecord(Key key)` readRecord returns a Record from the Filer based on the specified Key.
`boolean` `Filer.writeRecord(Key key, Value value)` writeRecord writes a Value to the Filer based on the specified Key.
`boolean` `Filer.deleteRecord(Key key)` deleteRecord removes a Record from the Filer based on the specified Key.
`Record` `FSFiler.readRecord(Key key)`
`boolean` `FSFiler.writeRecord(Key key, Value value)`
`boolean` `FSFiler.deleteRecord(Key key)` deleteRecord removes a Record from the Filer based on the specified Key.
`void` `Paged.PageHeader.setKey(Key key)`
`void` `Paged.Page.setKey(Key key)`

Uses of Key in org.dbxml.core.indexer

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

Methods in org.dbxml.core.indexer with parameters of type Key
`void` `ValueIndexer.remove(java.lang.String value, Key key, int pos, int len, short elemID, short attrID)`
`void` `ValueIndexer.add(java.lang.String value, Key key, int pos, int len, short elemID, short attrID)`
`void` `NameIndexer.remove(java.lang.String value, Key key, int pos, int len, short elemID, short attrID)`
`void` `NameIndexer.add(java.lang.String value, Key key, int pos, int len, short elemID, short attrID)`
`void` `IndexManager.addDocument(Key key, org.w3c.dom.Document doc)`
`void` `IndexManager.removeDocument(Key key, org.w3c.dom.Document doc)`
`void` `Indexer.remove(java.lang.String value, Key key, int pos, int len, short elemID, short attrID)` remove removes all references to the specified Key from the Indexer.
`void` `Indexer.add(java.lang.String value, Key key, int pos, int len, short elemID, short attrID)` add adds a Document to the Indexer.

Constructors in org.dbxml.core.indexer with parameters of type Key
`IndexMatch(Key key, int pos, int len, short elem, short attr)`
`IndexMatch(Key key, int pos, int len)`
`IndexMatch(Key key, IndexPattern pattern)`

Uses of Key in org.dbxml.core.query

Methods in org.dbxml.core.query that return Key
`Key[]` `Query.getKeySet()` getKeySet returns the initial set of Keys for this Query.
`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).

Methods in org.dbxml.core.query with parameters of type Key
`Query` `XPathQueryResolver.compileQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)`
`NodeSet` `XPathQueryResolver.query(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)`
`NodeSet` `QueryEngine.query(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).
`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.
`NodeSet` `QueryResolver.query(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)` query compiles a Query against the specified Collection context and returns the query results.

Uses of Key in org.dbxml.core.xupdate

Methods in org.dbxml.core.xupdate with parameters of type Key
`Query` `XUpdateQueryResolver.compileQuery(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)`
`NodeSet` `XUpdateQueryResolver.query(Collection context, java.lang.String query, NamespaceMap nsMap, Key[] keys)`

Uses of Key in org.dbxml.xml

Methods in org.dbxml.xml that return Key
`Key` `NodeSource.getKey()`

Constructors in org.dbxml.xml with parameters of type Key
`NodeSource(Collection collection, Key key)`

dbXML API

Copyright (c) 1999-2001 The dbXML Group, All rights reserved