|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.indexing.IndexManager
public class IndexManager
Manages all custom indexes registered with the database instance.
Field Summary | |
---|---|
static String |
CONFIGURATION_ELEMENT_NAME
|
static String |
CONFIGURATION_MODULE_ELEMENT_NAME
|
static String |
INDEXER_MODULES_CLASS_ATTRIBUTE
|
static String |
INDEXER_MODULES_ID_ATTRIBUTE
|
static String |
PROPERTY_INDEXER_MODULES
|
Constructor Summary | |
---|---|
IndexManager(BrokerPool pool,
Configuration config)
Constructs a new IndexManager and registers the indexes specified in the global configuration object, i.e. |
Method Summary | |
---|---|
void |
backupToArchive(RawDataBackup backup)
|
BrokerPool |
getBrokerPool()
Returns the BrokerPool on with this IndexManager operates. |
Index |
getIndexById(String indexId)
Returns the index registered with the provided ID. |
Index |
getIndexByName(String indexName)
Returns the index registered with the provided human-readable name. |
void |
removeIndexes()
Physically destroy the registered indexes by calling Index.remove()
on them. |
void |
reopenIndexes()
Reopens the registered index in case they have been closed by a previous operation such as Index.close() by calling Index.open()
on them. |
void |
shutdown()
Shutdowns all registered indexes by calling Index.close()
on them. |
void |
sync()
Call indexes to flush all data to disk. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CONFIGURATION_ELEMENT_NAME
public static final String CONFIGURATION_MODULE_ELEMENT_NAME
public static final String INDEXER_MODULES_CLASS_ATTRIBUTE
public static final String INDEXER_MODULES_ID_ATTRIBUTE
public static final String PROPERTY_INDEXER_MODULES
Constructor Detail |
---|
public IndexManager(BrokerPool pool, Configuration config) throws DatabaseConfigurationException
<modules> <module id="foo" class="bar" foo1="bar1" ... /> </modules>section of the configuration file.
pool
- the BrokerPool representing the current database instanceconfig
- the configuration object
DatabaseConfigurationException
Method Detail |
---|
public BrokerPool getBrokerPool()
BrokerPool
on with this IndexManager operates.
public Index getIndexById(String indexId)
indexId
- the ID
public Index getIndexByName(String indexName)
indexName
- the name
public void shutdown() throws DBException
Index.close()
on them.
DBException
public void sync() throws DBException
DBException
public void removeIndexes() throws DBException
Index.remove()
on them.
DBException
public void reopenIndexes() throws DatabaseConfigurationException
Index.close()
by calling Index.open()
on them.
DatabaseConfigurationException
public void backupToArchive(RawDataBackup backup) throws IOException
IOException
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |