|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.storage.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.getIdxConf(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(org.w3c.dom.Element index)
|
Method Summary | |
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)
|
int |
getIndexDepth()
Returns the current index depth, i.e. |
void |
read(org.w3c.dom.Element index)
Read index configurations from an "index" element node. |
void |
setIndexDepth(int depth)
Set the current index depth. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public IndexSpec(org.w3c.dom.Element index) throws DatabaseConfigurationException
Method Detail |
public void read(org.w3c.dom.Element index) throws DatabaseConfigurationException
FulltextIndexSpec
. The "create" elements
add a GeneralRangeIndexSpec
to the current configuration.
index
-
DatabaseConfigurationException
public int getIndexDepth()
public void setIndexDepth(int depth)
depth
- Current index depthgetIndexDepth()
public FulltextIndexSpec getFulltextIndexSpec()
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 java.lang.String toString()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |