Xindice API
version 1.1b4

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:
CVS $Revision: 1.21 $, $Date: 2004/02/08 02:51:06 $

Field Summary
static java.lang.String ACCESS
           
static java.lang.String CONFIGS
           
static java.lang.String GROUPS
           
static java.lang.String OBJECTS
           
static java.lang.String SYMBOLS
           
static java.lang.String SYSCOL
           
static java.lang.String USERS
           
 
Constructor Summary
SystemCollection(Database db)
           
 
Method Summary
 void dropSymbols(Collection collection)
          dropSymbols drop the SymbolTable for the specified Collection.
static java.lang.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, flushSymbolTable, getBinary, getCanonicalDocumentName, getCanonicalDocumentName, getCanonicalName, getCollectionMeta, getCollectionRoot, getContainer, getDatabase, getDocument, getDocumentCount, getDocumentMeta, getDocumentSet, getEntry, getFiler, getIndexer, getIndexManager, getName, getObject, getParentCollection, getQueryEngine, getSymbols, getSystemCollection, insertBinary, insertBinary, insertDocument, insertDocument, insertObject, insertObject, isMetaEnabled, isOpened, listDocuments, listIndexers, open, queryCollection, queryDocument, remove, 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 java.lang.String SYSCOL

SYMBOLS

public static final java.lang.String SYMBOLS

OBJECTS

public static final java.lang.String OBJECTS

CONFIGS

public static final java.lang.String CONFIGS

USERS

public static final java.lang.String USERS

GROUPS

public static final java.lang.String GROUPS

ACCESS

public static final java.lang.String ACCESS
Constructor Detail

SystemCollection

public SystemCollection(Database db)
Parameters:
db -  
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

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

dropSymbols

public void dropSymbols(Collection collection)
                 throws DBException
dropSymbols drop the SymbolTable for the specified Collection.
Parameters:
collection - The Collection that owns the SymbolTable

getDefinition

public static java.lang.String getDefinition()

Xindice API
version 1.1b4

Copyright (c) 1999-2004 The Apache Software Foundation. All Rights Reserved.