dbXML API

## Uses of Class
org.dbxml.core.DBException

Packages that use DBException
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.objects: Defines the dbXML XMLObject interface and implements XMLObjectManager, a reflection/invokation system and a Simple XMLObject implementation.
org.dbxml.core.query: Implements the dbXML QueryEngine and XPathQueryResolver.
org.dbxml.core.security: Defines several classes for dbXML access control and authentication.

Uses of DBException in org.dbxml.core

Methods in org.dbxml.core that throw DBException
`Collection` `CollectionManager.getCollection(java.lang.String path)` getCollection retrieves a Collection by name.
`java.lang.String[]` `CollectionManager.listCollections()` listCollections retrieves a list of Collections as an array of Strings.
`boolean` `CollectionManager.dropCollection(Collection collection)` dropCollection physically removes the specified Collection and any associated system resources that the Collection uses.
`Collection` `CollectionManager.createCollection(java.lang.String path, org.dbxml.server.Configuration config)` createCollection creates a new Collection object and any associated system resources that the Collection will need.
`Collection` `Collection.getParentCollection()` getParentCollection returns the parent Collection of this Collection.
`SystemCollection` `Collection.getSystemCollection()` getSystemCollection returns the System Collection.
`QueryEngine` `Collection.getQueryEngine()` getQueryEngine returns the Database's Query Engine
`Indexer` `Collection.getIndexer(java.lang.String name)` getIndexer retrieves an Indexer by name.
`java.lang.String[]` `Collection.listIndexers()` listIndexers returns a list of the currently registered Indexers as an array of String.
`boolean` `Collection.dropIndexer(Indexer index)` dropIndexer physically removes the specified Indexer and any associated system resources that the Indexer uses.
`Indexer` `Collection.createIndexer(org.dbxml.server.Configuration config)` createIndexer creates a new Indexer object and any associated system resources that the Indexer will need.
`IndexManager` `Collection.getIndexManager()` return the IndexManager being used by this Collection.
`XMLObjectManager` `Collection.getXMLObjectManager()` getXMLObjectManager returns the Object's XMLObjectManager.
`XMLObject` `Collection.getXMLObject(java.lang.String name)` getXMLObject retrieves an XMLObject by name.
`java.lang.String[]` `Collection.listXMLObjects()` listXMLObjects returns a list of the currently registered XMLObjects as an array of String.
`boolean` `Collection.dropXMLObject(XMLObject xmlObject)` dropXMLObject physically removes the specified XMLObject and any associated system resources that the XMLObject uses.
`XMLObject` `Collection.createXMLObject(org.dbxml.server.Configuration config)` createXMLObject creates a new XMLObject object and any associated system resources that the XMLObject will need.
`SymbolTable` `Collection.getSymbols()` getSymbols returns the SymbolTable in use by this Collection.
`boolean` `Collection.open()`
`boolean` `Collection.isOpened()`
`boolean` `Collection.exists()`
`boolean` `Collection.close()`
`boolean` `Collection.create()`
`boolean` `Collection.drop()`
`void` `Collection.flushSymbolTable()`
`Key` `Collection.insertDocument(org.w3c.dom.Document document)` insertDocument inserts a new Document into a dbXML Collection.
`void` `Collection.insertDocument(java.lang.Object docKey, org.w3c.dom.Document document)` insertDocument inserts a new Document into a dbXML Collection.
`void` `Collection.setDocument(java.lang.Object docKey, org.w3c.dom.Document document)` setDocument overwrites/updates an existing Document in a dbXML Collection.
`void` `Collection.remove(java.lang.Object key)` remove removes an object from the Collection based on its Key, regardless of it's type.
`org.w3c.dom.Document` `Collection.getDocument(java.lang.Object docKey)` getDocument retrieves a Document by Key.
`Container` `Collection.getContainer(java.lang.Object docKey)` getContainer retrieves a Container from the Collection.
`XMLSerializable` `Collection.getObject(java.lang.Object key)` getObject instantiates and returns an XMLSerializable object based on the provided Key.
`void` `Collection.setObject(java.lang.Object key, XMLSerializable obj)` setObject sets an XMLSerializable object in the Collection based on the provided Key.
`Key` `Collection.insertObject(XMLSerializable obj)` insertObject inserts an XMLSerializable object into the Collection and returns a newly generated Key.
`void` `Collection.insertObject(java.lang.String key, XMLSerializable obj)` insertObject inserts an XMLSerializable object into the Collection based on the specified Key.
`NodeSet` `Collection.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` `Collection.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.
`DocumentSet` `Collection.getDocumentSet()` getDocumentSet returns the set of Documents being maintained by this Collection.
`java.lang.String[]` `Collection.listDocuments()` listDocuments returns a list of all document keys stored by this collection.
`long` `Collection.getDocumentCount()` getDocumentCount returns the count of Documents being maintained by this Collection.
`URIMapper` `Database.getURIMapper(java.lang.String uri)` getURIMapper returns a pooled URIMapper instance.
`SymbolTable` `SystemCollection.loadSymbols(Collection collection)` loadSymbols retrieves the SymbolTable for the specified Collection.
`void` `SystemCollection.saveSymbols(Collection collection, SymbolTable symbols)` saveSymbols save the SymbolTable for the specified Collection.
`boolean` `DBObject.create()` create creates a new DBObject and any associated resources for the new DBObject, such as disk files, etc.
`boolean` `DBObject.open()` open opens the DBObject
`boolean` `DBObject.isOpened()` isOpened returns whether or not the DBObject is opened for business.
`boolean` `DBObject.exists()` exists returns whether or not a physical representation of this DBObject actually exists.
`boolean` `DBObject.drop()` drop instructs the DBObjectimplementation to remove itself from existence.
`boolean` `DBObject.close()` close closes the DBObject
`java.lang.String` `Container.getCanonicalName()` getCanonicalName returns the canonical name for the contained Document.
`org.w3c.dom.Document` `Container.rollback()` rollback reloads the Document from the Collection.
`void` `Container.remove()` delete removes the Document from the Collection.
`void` `Container.commit()` commit saves the Document in the Collection.
`void` `Container.commit(org.w3c.dom.Document document)` commit replaces the Document in the Collection with the specified Document.

Uses of DBException in org.dbxml.core.data

Methods in org.dbxml.core.data that throw DBException
`boolean` `DocumentSet.hasMoreDocuments()` hasMoreDocuments returns whether there are any more Documents left in the set.
`org.w3c.dom.Document` `DocumentSet.getNextDocument()` getNextDocument returns the next Document in the set.
`Container` `DocumentSet.getNextContainer()` getNextContainer returns the next Document in the set wrapped in a Collection Container.
`boolean` `RecordSet.hasMoreRecords()` hasMoreRecords returns whether or not there are any Records left in the set.
`Record` `RecordSet.getNextRecord()` getNextRecord returns the next Record in the set.
`Key` `RecordSet.getNextKey()` getNextKey returns the next Record's Key, and skips the RecordSet ahead to the next Record.
`Value` `RecordSet.getNextValue()` getNextValue returns the next Record's Value, and skips the RecordSet ahead to the next Record.

Uses of DBException in org.dbxml.core.filer

Subclasses of DBException in org.dbxml.core.filer
`class` `BTreeCorruptException` A BTreecorruptException is thrown by the BTree if the BTree appears to be corrupted in some way.
`class` `BTreeException` A BTreeException is thrown by the BTree if an exception occurs in the managing of the BTree.
`class` `BTreeNotFoundException` A BTreeNotFoundException is thrown by the BTree if a Value can't be found in the BTree.
`class` `FilerException` A FilerException is thrown by a Filer if an exception occurs in the managing of the Filer.

Methods in org.dbxml.core.filer that throw DBException
`boolean` `Paged.create()`
`boolean` `Paged.open()`
`boolean` `Paged.close()`
`boolean` `Paged.drop()`
`boolean` `BTree.open()`
`boolean` `BTree.create()`
`boolean` `BTreeFiler.open()`
`boolean` `BTreeFiler.create()`
`Record` `BTreeFiler.readRecord(Key key)`
`boolean` `BTreeFiler.writeRecord(Key key, Value value)`
`boolean` `BTreeFiler.deleteRecord(Key key)`
`long` `BTreeFiler.getRecordCount()`
`RecordSet` `BTreeFiler.getRecordSet()`
`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.
`long` `MemFiler.getRecordCount()` getRecordCount returns the number of Records in the Filer.
`RecordSet` `MemFiler.getRecordSet()` getRecordSet returns a RecordSet object for the current Filer.
`boolean` `HashFiler.open()`
`boolean` `HashFiler.create()`
`Record` `HashFiler.readRecord(Key key)`
`boolean` `HashFiler.writeRecord(Key key, Value value)`
`boolean` `HashFiler.deleteRecord(Key key)`
`long` `HashFiler.getRecordCount()`
`RecordSet` `HashFiler.getRecordSet()`
`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.
`long` `Filer.getRecordCount()` getRecordCount returns the number of Records in the Filer.
`RecordSet` `Filer.getRecordSet()` getRecordSet returns a RecordSet object for the current Filer.
`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.
`long` `FSFiler.getRecordCount()`
`RecordSet` `FSFiler.getRecordSet()`

Uses of DBException in org.dbxml.core.indexer

Subclasses of DBException in org.dbxml.core.indexer
`class` `CannotCreateException` A CannotCreateException is thrown if an Indexer cannot be properly created in the server context for some reason.
`class` `DuplicateIndexException` A DuplicateIndexException is thrown if an Indexer create attempt duplicates an existing Indexer.
`class` `IndexerException` A IndexerException is thrown by an Indexer if an exception occurs in the managing of the Indexer.

Methods in org.dbxml.core.indexer that throw DBException
`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)`
`IndexMatch[]` `ValueIndexer.queryMatches(IndexQuery query)`
`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)`
`IndexMatch[]` `NameIndexer.queryMatches(IndexQuery query)`
`Indexer` `IndexManager.create(org.dbxml.server.Configuration cfg)` create creates a new Indexer object and any associated system resources that the Indexer will need.
`Indexer` `IndexManager.register(java.lang.Class c, org.dbxml.server.Configuration cfg)`
`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.
`IndexMatch[]` `Indexer.queryMatches(IndexQuery query)` queryMatches retrieves a set of MatchEntry instances that match the supplied query.

Uses of DBException in org.dbxml.core.objects

Subclasses of DBException in org.dbxml.core.objects
`class` `ClassFormatException` A ClassFormatException is thrown if an XMLObject exposes overloaded methods or other non-supported signatures.
`class` `DuplicateObjectException` A DuplicateObjectException is thrown if an XMLObject create attempt duplicates an existing XMLObject.
`class` `InvalidContextException` A InvalidContextException is thrown if an XMLObject does not belong to a specified context.
`class` `MethodNotFoundException` A MethodNotFoundException is thrown by the Reflector if a method lookup failes on an XMLObject.
`class` `XMLObjectException` A XMLObjectException is thrown by the Reflector if an exception occurs in the reflection, lookup, or execution of an XMLObject's method.
`class` `XMLObjectRuntimeException` A XMLObjectRuntimeException is thrown if an uncaught Exception occurs while executing an XMLObject's method.

Methods in org.dbxml.core.objects that throw DBException
`XMLObject` `XMLObjectManager.create(org.dbxml.server.Configuration cfg)` create creates a new XMLObject object and any associated system resources that the XMLObject will need.
`XMLObject` `XMLObjectManager.register(java.lang.Class c, org.dbxml.server.Configuration cfg)`

Uses of DBException in org.dbxml.core.query

Subclasses of DBException in org.dbxml.core.query
`class` `CompilationException` A CompilationException is thrown by a Query if for some reason, it can't compile the query being processed.
`class` `ProcessingException` A ProcessingException is thrown by a Query if for some reason, it fails to actually process the query request.
`class` `QueryException` A QueryException is thrown by a Query if an exception occurs in the processing of the Query.
`class` `StyleNotFoundException` A StyleNotFoundException is thrown by a Query if the QueryEngine can't resolve a specified style name.

Methods in org.dbxml.core.query that throw DBException
`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.

Uses of DBException in org.dbxml.core.security

Subclasses of DBException in org.dbxml.core.security
`class` `AccessDeniedException` A AccessDeniedException is thrown if access is denied to a resource within the database.
`class` `InvalidCredentialsException` A InvalidCredentialsException is thrown if the credentials used in an access control method are invalid.
`class` `InvalidPasswordException` A InvalidPasswordException is thrown if access is denied to a resource within the database.
`class` `SecurityException` A SecurityException is thrown if access is denied to a resource within the database.
`class` `UnknownUserException` A UnknownUserException is thrown if access is denied to a resource within the database.

dbXML API

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