|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Index
Represents an arbitrary index structure that can be used by eXist. This is the main interface to be registered with the database instance. It provides methods to configure, open and close the index. These methods will be called by the main database instance during startup/shutdown. They don't need to be synchronized.
Method Summary | |
---|---|
boolean |
checkIndex(DBBroker broker)
Convenience method that allows to check index consistency. |
void |
close()
Closes the index and all associated resources. |
void |
configure(BrokerPool pool,
String dataDir,
Element config)
Configure the index and all resources associated with it. |
BrokerPool |
getBrokerPool()
Returns the BrokerPool on with this Index operates. |
String |
getIndexId()
Returns an id which uniquely identifies this index. |
String |
getIndexName()
Returns a human-readable name which uniquely identifies this index. |
IndexWorker |
getWorker(DBBroker broker)
Returns a new IndexWorker, which is used to access the index in a multi-threaded environment. |
void |
open()
Opens the index for writing and reading. |
void |
remove()
Closes the index and removes it completely, including all resources and files associated to it. |
void |
sync()
Sync the index. |
Method Detail |
---|
String getIndexId()
String getIndexName()
BrokerPool getBrokerPool()
BrokerPool
on with this Index operates.
void configure(BrokerPool pool, String dataDir, Element config) throws DatabaseConfigurationException
<module id="foo" class="bar"/>section of the configuration file.
pool
- the BrokerPool representing the current database instance.dataDir
- the main data directory where eXist stores its files (if relevant).config
- the module element which configures this index, as found in conf.xml
DatabaseConfigurationException
void open() throws DatabaseConfigurationException
DatabaseConfigurationException
void close() throws DBException
DBException
void sync() throws DBException
DBException
void remove() throws DBException
DBException
IndexWorker getWorker(DBBroker broker)
DBBroker
objects. All operations on the db
have to go through one of these brokers. Each DBBroker retrieves an
IndexWorker for every index by calling this method.
broker
- The DBBroker that owns this worker
boolean checkIndex(DBBroker broker)
broker
- the broker that will perform the operation.
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |