org.apache.xindice.core
Class Database

java.lang.Object
  |
  +--org.apache.xindice.core.CollectionManager
        |
        +--org.apache.xindice.core.Collection
              |
              +--org.apache.xindice.core.Database

All Implemented Interfaces:

Configurable, DBObject, Disposable, Named

public final class Database

extends Collection

implements Named

Database is the primary container for the Xindice Database Engine.

Field Summary

static java.lang.String

PROP_XINDICE_HOME

Constructor Summary

Database()

Method Summary

boolean	close() close closes the DBObject
void	flushConfig() flushConfig ensures that the Collection configuration has been properly flushed to disk after a modification.
Database	getDatabase() getDatabase returns the Database owner for this Collection.
static Database	getDatabase(java.lang.String name)
DocumentCache	getDocumentCache() getDocumentCache returns the Database-level Document Cache.
QueryEngine	getQueryEngine() getQueryEngine returns a reference to the Database's current operating QueryEngine implementation.
DBSecurityManager	getSecurityManager() Returns the security manager instance for this Database.
SystemCollection	getSystemCollection() getSystemCollection returns the System Collection.
URIMapper	getURIMapper() getURIMapper returns a pooled URIMapper instance.
URIMapper	getURIMapper(java.lang.String uri) getURIMapper returns a pooled URIMapper instance.
static java.lang.String[]	listDatabases()
void	setConfig(Configuration config) setConfig sets the configuration information for the Configurable object instance.

Methods inherited from class org.apache.xindice.core.Collection

create, createCollection, createIndexer, createNewOID, createXMLObject, dispose, drop, dropCollection, dropIndexer, dropXMLObject, exists, flushSymbolTable, getCanonicalDocumentName, getCanonicalName, getCollectionRoot, getContainer, getDocument, getDocumentCount, getDocumentSet, getFiler, getIndexer, getIndexManager, getName, getObject, getParentCollection, getSymbols, getXMLObject, getXMLObjectManager, insertDocument, insertDocument, insertObject, insertObject, isOpened, listDocuments, listIndexers, listXMLObjects, open, queryCollection, queryDocument, remove, setDocument, setObject

Methods inherited from class org.apache.xindice.core.CollectionManager

getCollection, getConfig, listCollections

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.xindice.util.Named

getName

Methods inherited from interface org.apache.xindice.util.Configurable

getConfig

Field Detail

PROP_XINDICE_HOME

public static final java.lang.String PROP_XINDICE_HOME

Constructor Detail

Database

public Database()

Method Detail

getDatabase

public static Database getDatabase(java.lang.String name)

listDatabases

public static java.lang.String[] listDatabases()

setConfig

public void setConfig(Configuration config)

Description copied from interface: Configurable

setConfig sets the configuration information for the Configurable object instance.

Overrides:

setConfig in class Collection

Following copied from interface: org.apache.xindice.util.Configurable

Parameters:

config - The configuration Node

getSystemCollection

public SystemCollection getSystemCollection()

Description copied from class: Collection

getSystemCollection returns the System Collection.

Overrides:

getSystemCollection in class Collection

Following copied from class: org.apache.xindice.core.Collection

Returns:

The System Collection

getDatabase

public Database getDatabase()

Description copied from class: Collection

getDatabase returns the Database owner for this Collection.

Overrides:

getDatabase in class Collection

Following copied from class: org.apache.xindice.core.Collection

Returns:

The Database

flushConfig

public void flushConfig()

flushConfig ensures that the Collection configuration has been properly flushed to disk after a modification.

close

public boolean close()
              throws DBException

Description copied from interface: DBObject

close closes the DBObject

Overrides:

close in class Collection

Following copied from interface: org.apache.xindice.core.DBObject

Returns:

Whether or not the DBObject was closed

getURIMapper

public URIMapper getURIMapper()

getURIMapper returns a pooled URIMapper instance.

Returns:

A Pooled URIMapper

getURIMapper

public URIMapper getURIMapper(java.lang.String uri)
                       throws DBException

getURIMapper returns a pooled URIMapper instance.

Parameters:

uri - The URI to resolve

Returns:

A Pooled (and resolved) URIMapper

getDocumentCache

public DocumentCache getDocumentCache()

getDocumentCache returns the Database-level Document Cache.

Returns:

The DocumentCache

getQueryEngine

public QueryEngine getQueryEngine()

getQueryEngine returns a reference to the Database's current operating QueryEngine implementation.

Overrides:

getQueryEngine in class Collection

Returns:

The QueryEngine instance

getSecurityManager

public DBSecurityManager getSecurityManager()

Returns the security manager instance for this Database.

Returns:

The security manager