|
Xindice API version 1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xindice.core.CollectionManager | +--org.apache.xindice.core.Collection | +--org.apache.xindice.core.Database
Database is the primary container for the Xindice Database Engine.
Field Summary | |
static String |
DBROOT
|
static String |
DBROOT_DEFAULT
|
static String |
NAME
|
Constructor Summary | |
Database()
|
Method Summary | |
boolean |
close()
close closes the DBObject |
protected boolean |
close(boolean removeFromShutdown)
Checks to see if it has been closed to insure that it doesn't try to do it twice. |
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(Configuration config)
This will return an instance of a Database for the given name if one has already been loaded, otherwise it will create a new instance. |
static Database |
getDatabase(String name)
This will merely return an instance of a Database for the given name if one has already been loaded. |
DocumentCache |
getDocumentCache()
getDocumentCache returns the Database-level Document Cache. |
MetaSystemCollection |
getMetaSystemCollection()
Return the MetaSystem collection for this database. |
QueryEngine |
getQueryEngine()
getQueryEngine returns a reference to the Database's current operating QueryEngine implementation. |
SystemCollection |
getSystemCollection()
getSystemCollection returns the System Collection. |
protected Timer |
getTimer()
Return database's timer instance. |
boolean |
isMetaEnabled()
Return whether or not metadata is enabled on this database. |
static String[] |
listDatabases()
|
void |
setConfig(Configuration config)
setConfig sets the configuration information for the Configurable object instance. |
Methods inherited from class org.apache.xindice.core.CollectionManager |
addCollection, countCollections, getCollection, getCollections, getConfig, listCollections |
Methods inherited from class java.lang.Object |
clone, equals, finalize, 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 |
public static final String DBROOT
public static final String NAME
public static final String DBROOT_DEFAULT
Constructor Detail |
public Database()
Method Detail |
public static Database getDatabase(Configuration config)
config
- Database configurationConfigurationException
- if database name is missing in the configurationpublic static Database getDatabase(String name)
name
- Database namepublic static String[] listDatabases()
protected boolean close(boolean removeFromShutdown) throws DBException
removeFromShutdown
- If true removes its self from the shutdown hookDBException
- if unable to closepublic boolean close() throws DBException
DBObject
close
in class Collection
DBObject.close()
,
close(boolean removeFromShutdown)
public void flushConfig()
public Database getDatabase()
Collection
getDatabase
in class Collection
Collection.getDatabase()
public DocumentCache getDocumentCache()
public MetaSystemCollection getMetaSystemCollection()
public QueryEngine getQueryEngine()
getQueryEngine
in class Collection
public SystemCollection getSystemCollection()
Collection
getSystemCollection
in class Collection
Collection.getSystemCollection()
protected Timer getTimer()
public boolean isMetaEnabled()
isMetaEnabled
in class Collection
public void setConfig(Configuration config) throws XindiceException
Configurable
setConfig
in class Collection
Configurable.setConfig(org.apache.xindice.util.Configuration)
|
Xindice API version 1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |