|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Adapter defines an interface that allows adapter facades to be developed in order to allow dbXML to persist objects other than dbXML DocumentTable instances. These might include DOM Documents, JAXB-generated classes, or XMLSerializable instances.
Method Summary | |
java.lang.String |
getCanonicalName()
getCanonicalName returns the canonical name for the underlying Collection. |
Collection |
getCollection()
getCollection returns a reference to the underlying Collection. |
long |
getKeyCount(Transaction tx)
getKeyCount returns the count of objects being maintained by this Adapter. |
java.lang.String |
getName()
getName returns the name for the underlying Collection. |
Key[] |
listKeys(Transaction tx)
listKeys returns a list of object keys stored managed by the Adapter. |
ResultSet |
queryCollection(Transaction tx,
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. |
ResultSet |
queryDocument(Transaction tx,
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(Transaction tx,
java.lang.Object key)
remove removes an object from the Adapter based on its Key. |
Method Detail |
public Collection getCollection()
public java.lang.String getName()
public java.lang.String getCanonicalName()
public Key[] listKeys(Transaction tx) throws DBException
tx
- The controlling Transaction
DBException
- If a Database Exception occurspublic void remove(Transaction tx, java.lang.Object key) throws DBException
tx
- The controlling Transactionkey
- The Object's Key
DBException
- If a Database Exception occurspublic long getKeyCount(Transaction tx) throws DBException
tx
- The controlling Transaction
DBException
- If a Database Exception occurspublic ResultSet queryCollection(Transaction tx, java.lang.String style, java.lang.String query, NamespaceMap nsMap) throws DBException
tx
- The controlling Transactionstyle
- The query style to use (ex: XPath)query
- The query to executensMap
- The namespace Map (if any)
DBException
- If a Database Exception occurspublic ResultSet queryDocument(Transaction tx, java.lang.String style, java.lang.String query, NamespaceMap nsMap, java.lang.Object key) throws DBException
tx
- The controlling Transactionstyle
- The query style to use (ex: XPath)query
- The query to executensMap
- The namespace Map (if any)key
- The Document to query
DBException
- If a Database Exception occurs
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |