public interface IndexBuildSpecification extends XMLizable, Serializable
CAS get indexed with a UIMA-compliant search engine.
This is done by providing rules that describe how different types of Annotations in the CAS
should be indexed.
This object implements the XMLizable interface and can be parsed from an XML
representation. The XML representation is as follows:
<indexBuildSpecification>
<indexBuildItem>
<name> CAS_TYPE_NAME | CAS_TYPE_NAMESPACE_WILDCARD </name>
<indexRule>
<style name="NAME">
<attribute name="NAME" value="STRING"/>
...
[<attributeMappings>
<mapping>
<feature> STRING </feature>
<indexName> STRING </indexName>
</mapping>
...
</attributeMappings>]
</style>
...
</indexRule>
[<filter syntax="NAME"> FILTER_EXPRESSION </filter>]
</indexBuildItem>
...
</indexBuildSpecification>
The ... indicates repeating elements of the same type - for example an
indexBuildSpecification may have multiple indexBuildItems. The
square brackets indicate optionality, hence filter is an optional element of
indexRule.
.*, for
example org.apache.myproject.*Style and Filter
classes.syntax attribute on the filter element. See Filter for
details. Attribute and Mapping for details.| Modifier and Type | Method and Description |
|---|---|
IndexBuildItem[] |
getIndexBuildItems()
Gets the
IndexBuildItem objects that comprise this index build specification. |
void |
setIndexBuildItems(IndexBuildItem[] aItems)
Sets the
IndexBuildItem objects that comprise this index build specification. |
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXMLIndexBuildItem[] getIndexBuildItems()
IndexBuildItem objects that comprise this index build specification.
Each of these identifies an annotation type and describes how it should be indexed.void setIndexBuildItems(IndexBuildItem[] aItems)
IndexBuildItem objects that comprise this index build specification.
Each of these identifies an annotation type and describes how it should be indexed.aItems - the build itemsCopyright © 2006–2017 The Apache Software Foundation. All rights reserved.