|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.storage.IndexSpec
public class IndexSpec
Top class for index definitions as specified in a collection configuration
or the main configuration file. The IndexSpec for a given collection can be retrieved through method
Collection.getIndexConfiguration(DBBroker)
.
An index definition should have the following structure:
<index index-depth="idx-depth"> <fulltext default="all|none" attributes="true|false"> <include path="node-path"/> <exclude path="node-path"/> </fulltext> <create path="node-path" type="schema-type"> </index>
Constructor Summary | |
---|---|
IndexSpec(DBBroker broker,
Element index)
|
Method Summary | |
---|---|
Object |
getCustomIndexSpec(String id)
Returns the configuration object registered for the non-core index identified by id. |
FulltextIndexSpec |
getFulltextIndexSpec()
Returns the fulltext index configuration object for the current configuration. |
GeneralRangeIndexSpec |
getIndexByPath(NodePath path)
Returns the GeneralRangeIndexSpec defined for the given
node path or null if no index has been configured. |
QNameRangeIndexSpec |
getIndexByQName(QName name)
|
List |
getIndexedQNames()
|
boolean |
hasIndexesByPath()
|
boolean |
hasIndexesByQName()
|
void |
read(DBBroker broker,
Element index)
Read index configurations from an "index" element node. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public IndexSpec(DBBroker broker, Element index) throws DatabaseConfigurationException
DatabaseConfigurationException
Method Detail |
---|
public void read(DBBroker broker, Element index) throws DatabaseConfigurationException
FulltextIndexSpec
. The "create" elements
add a GeneralRangeIndexSpec
to the current configuration.
index
-
DatabaseConfigurationException
public FulltextIndexSpec getFulltextIndexSpec()
public Object getCustomIndexSpec(String id)
id
- the id used to identify this index.
public GeneralRangeIndexSpec getIndexByPath(NodePath path)
GeneralRangeIndexSpec
defined for the given
node path or null if no index has been configured.
path
- public QNameRangeIndexSpec getIndexByQName(QName name)
public boolean hasIndexesByPath()
public boolean hasIndexesByQName()
public List getIndexedQNames()
public String toString()
toString
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |