org.apache.xindice.core
Class SystemCollection

java.lang.Object
  org.apache.xindice.core.CollectionManager
      org.apache.xindice.core.Collection
          org.apache.xindice.core.SystemCollection

All Implemented Interfaces:

Configurable, DBObject, Named

public final class SystemCollection

extends Collection

SystemCollection represents the System Collection. Beyond standard Collection operations, this class will provide facilities for Schema and SymbolTable management among other things.

Version:

$Revision: 568786 $, $Date: 2007-08-22 20:40:57 -0400 (Wed, 22 Aug 2007) $

Field Summary

static String	ACCESS
static String	CONFIGS
static String	GROUPS
static String	OBJECTS
static String	SYMBOLS
static String	SYSCOL
static String	USERS

Constructor Summary

SystemCollection(Database db)

Method Summary

void	dropSymbols(Collection collection) dropSymbols drop the SymbolTable for the specified Collection.
static String	getDefinition()
SymbolTable	loadSymbols(Collection collection) loadSymbols retrieves the SymbolTable for the specified Collection.
void	saveSymbols(Collection collection, SymbolTable symbols) saveSymbols save the SymbolTable for the specified Collection.

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

close, create, createCollection, createIndexer, createNewKey, createNewOID, drop, dropCollection, dropIndexer, exists, getBinary, getCanonicalDocumentName, getCanonicalDocumentName, getCanonicalName, getCollectionMeta, getCollectionRoot, getContainer, getDatabase, getDocument, getDocumentCount, getDocumentMeta, getDocumentSet, getEntry, getEntryMeta, getFiler, getIndexer, getIndexManager, getName, getObject, getParentCollection, getQueryEngine, getSymbols, getSystemCollection, insertBinary, insertBinary, insertDocument, insertDocument, insertObject, insertObject, isMetaEnabled, isOpened, listDocuments, listIndexers, open, queryCollection, queryDocument, remove, setBinary, setCanonicalName, setCollectionMeta, setCollectionRoot, setConfig, setDocument, setDocumentMeta, setName, setObject, updateCollectionMeta, updateDocumentMeta

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.Configurable

getConfig

Field Detail

SYSCOL

public static final String SYSCOL

See Also:

Constant Field Values

SYMBOLS

public static final String SYMBOLS

See Also:

Constant Field Values

OBJECTS

public static final String OBJECTS

See Also:

Constant Field Values

CONFIGS

public static final String CONFIGS

See Also:

Constant Field Values

USERS

public static final String USERS

See Also:

Constant Field Values

GROUPS

public static final String GROUPS

See Also:

Constant Field Values

ACCESS

public static final String ACCESS

See Also:

Constant Field Values

Constructor Detail

SystemCollection

public SystemCollection(Database db)

Parameters:

db - Its database

Method Detail

loadSymbols

public SymbolTable loadSymbols(Collection collection)
                        throws DBException

loadSymbols retrieves the SymbolTable for the specified Collection.

Parameters:

collection - The Collection whose SymbolTable is required

Returns:

The requested SymbolTable

Throws:

DBException - if unable to load symbols

saveSymbols

public void saveSymbols(Collection collection,
                        SymbolTable symbols)
                 throws DBException

saveSymbols save the SymbolTable for the specified Collection.

Parameters:

collection - The Collection that owns the SymbolTable

symbols - The SymbolTable

Throws:

DBException - if unable to save symbols

dropSymbols

public void dropSymbols(Collection collection)
                 throws DBException

dropSymbols drop the SymbolTable for the specified Collection.

Parameters:

collection - The Collection that owns the SymbolTable

Throws:

DBException - if unable to drop symbols

getDefinition

public static String getDefinition()