|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.dbxml.util.SimpleConfigurable
com.dbxml.db.core.indexer.IndexManager
IndexManager is a class that manages Indexes. Good description, eh? I should win a Pulitzer Prize for that one.
Constructor Summary | |
IndexManager(Collection collection)
|
Method Summary | |
void |
addDocument(Transaction tx,
Key key,
DocumentTable doc)
|
void |
closeAll()
closeAll closes all opened Indexers. |
Indexer |
create(Configuration cfg)
create creates a new Indexer object and any associated system resources that the Indexer will need. |
boolean |
drop(java.lang.String name)
drop physically removes the specified Indexer and any associated system resources that the Indexer uses. |
Indexer |
get(java.lang.String name)
get retrieves an Indexer by name. |
Indexer |
getBestIndexer(java.lang.String style,
IndexPattern pattern)
getBestIndexer retrieves the best Indexer to use for the specified IndexPattern. |
java.lang.String[] |
list()
list returns a list of the Indexers that this IndexerManager has registered. |
void |
removeDocument(Transaction tx,
Key key,
DocumentTable doc)
|
void |
setConfig(Configuration config)
setConfig sets the configuration information for the Configurable object instance. |
static void |
setMagicUser(User magicUser)
|
static void |
setUserStack(UserStack userStack)
|
Methods inherited from class com.dbxml.util.SimpleConfigurable |
getConfig |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public IndexManager(Collection collection)
Method Detail |
public void setConfig(Configuration config) throws dbXMLException
Configurable
setConfig
in interface Configurable
setConfig
in class SimpleConfigurable
dbXMLException
public static void setMagicUser(User magicUser) throws SecurityException
SecurityException
public static void setUserStack(UserStack userStack) throws SecurityException
SecurityException
public java.lang.String[] list()
public boolean drop(java.lang.String name) throws DBException
name
- The Indexer to drop
DBException
public Indexer create(Configuration cfg) throws DBException
cfg
- The Indexer's configuration
DBException
public void closeAll()
public Indexer get(java.lang.String name)
name
- The Indexer name
public Indexer getBestIndexer(java.lang.String style, IndexPattern pattern)
style
- The Indexer Style (ex: Node, Value)pattern
- The IndexPattern to use
public void addDocument(Transaction tx, Key key, DocumentTable doc)
public void removeDocument(Transaction tx, Key key, DocumentTable doc)
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |