com.bluestream.xdb.dsobject.config
Interface DatabaseTree

public interface DatabaseTree

DatabaseTree contains an immediate list of DatabaseListItems. Data available is similar to that returned by the GetDatabaseTree() command.

Method Summary

Database	getDatabase(String objectId) Get the database as identified by objectId.
Iterator	getDatabaseIter() Get an iterator to all the databases.
Iterator	getDatabaseListItemIter() Returns an iterator to the DatabaseItems for this DatabaseTree
FullTextIndex	getFullTextIndex(String oidIndex) Get the fulltext index identified by oidIndex.
Root	getRoot(String objectId) Get the root for the root identified by objectId.
Iterator	getRootIter(String oidDatabase) Get an iterator to all the Roots for a given database.
RootTree	getRootTree(String oidDatabase) Get the RootTree for the database identified by oidDatabase.
Trigger	getTrigger(String oidTrigger) Get the trigger identified by oidTrigger.
ValueIndex	getValueIndex(String oidIndex) Get the value index identified by oidIndex.

Method Detail

getDatabaseListItemIter

public Iterator getDatabaseListItemIter()
                                 throws XDBException

Returns an iterator to the DatabaseItems for this DatabaseTree

Throws:

XDBException

getDatabase

public Database getDatabase(String objectId)
                     throws XDBException

Get the database as identified by objectId.

Returns:

db - null for not found.

Throws:

XDBException

getDatabaseIter

public Iterator getDatabaseIter()
                         throws XDBException

Get an iterator to all the databases. This is a sweetener in that it could be accomplished by iterating down through the DBTree.

Returns:

iterDatabases

Throws:

XDBException

getRoot

public Root getRoot(String objectId)
             throws XDBException

Get the root for the root identified by objectId. This is a sweetener in that it could be done by iterating down thru the DBTree.

Returns:

Root - null for not found XDBException SysErr.EC_NotFound - for database not found.

Throws:

XDBException

getRootIter

public Iterator getRootIter(String oidDatabase)
                     throws XDBException

Get an iterator to all the Roots for a given database. Depending on the context, the GetRoots(dbName) command may be faster than this. As well, this call has to do somewhat more work than by going through the RootTree if you are already iterating DatabaseListItems under the DatabaseTree.

Throws:

XDBException

getRootTree

public RootTree getRootTree(String oidDatabase)
                     throws XDBException

Get the RootTree for the database identified by oidDatabase.

Returns:

RootTree - null for not found

Throws:

XDBException

getValueIndex

public ValueIndex getValueIndex(String oidIndex)
                         throws XDBException

Get the value index identified by oidIndex. This is a sweetener in that it could be done by iterating down thru the DBTree.

Returns:

valueIndex - null for not found XDBException SysErr.EC_NotFound - for value index not found.

Throws:

XDBException

getFullTextIndex

public FullTextIndex getFullTextIndex(String oidIndex)
                               throws XDBException

Get the fulltext index identified by oidIndex. This is a sweetener in that it could be done by iterating down thru the DBTree.

Returns:

fulltextIndex - null for not found XDBException SysErr.EC_NotFound - for fulltext index not found.

Throws:

XDBException

getTrigger

public Trigger getTrigger(String oidTrigger)
                   throws XDBException

Get the trigger identified by oidTrigger. This is a sweetener in that it could be done by iterating down thru the DBTree.

Returns:

trigger - null for not found XDBException SysErr.EC_NotFound - for trigger not found.

Throws:

XDBException