Package org.apache.uima.search
Interface IndexBuildItem
- All Superinterfaces:
Serializable,XMLizable
- All Known Implementing Classes:
IndexBuildItem_impl
An individual item within a
IndexBuildSpecification. Specifies the getName()
name of a CAS type, a index rule, and an optional filter.
This object implements the XMLizable interface and can be parsed from an XML
representation.
-
Method Summary
Modifier and TypeMethodDescriptionGets theFilterthat identifies which instances of the named CAS type are governed by the index rule for this item.Gets theIndexRulethat defines how annotations matching this build item should be indexed.getName()Gets the name of the CAS type for which this item defines the indexing behavior.voidSets theFilterthat identifies which instances of the named CAS type are governed by the index rule for this item.voidsetIndexRule(IndexRule aRule) Sets theIndexRulethat defines how annotations matching this build item should be indexed.voidSets the name of the CAS type for which this item defines the indexing behavior.Methods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
getName
String getName()Gets the name of the CAS type for which this item defines the indexing behavior.- Returns:
- the CAS type name for this build item
-
setName
Sets the name of the CAS type for which this item defines the indexing behavior.- Parameters:
aName- the CAS type name for this build item
-
getIndexRule
IndexRule getIndexRule()Gets theIndexRulethat defines how annotations matching this build item should be indexed.- Returns:
- the indexing rule for this build item
-
setIndexRule
Sets theIndexRulethat defines how annotations matching this build item should be indexed.- Parameters:
aRule- the indexing rule for this build item
-
getFilter
Filter getFilter()Gets theFilterthat identifies which instances of the named CAS type are governed by the index rule for this item. Filters are optional; if none is specified then this rule applies to all instances of the named CAS type.- Returns:
- the Filter for this build item, null if none
-
setFilter
Sets theFilterthat identifies which instances of the named CAS type are governed by the index rule for this item. Filters are optional; if none is specified then this rule applies to all instances of the named CAS type.- Parameters:
aFilter- the Filter for this build item, null if none
-