Package org.apache.uima.search
Interface IndexBuildItem
-
- All Superinterfaces:
java.io.Serializable
,XMLizable
- All Known Implementing Classes:
IndexBuildItem_impl
public interface IndexBuildItem extends XMLizable, java.io.Serializable
An individual item within aIndexBuildSpecification
. Specifies thegetName()
name of a CAS type, aindex rule
, and an optionalfilter
.This object implements the
XMLizable
interface and can be parsed from an XML representation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Filter
getFilter()
Gets theFilter
that identifies which instances of the named CAS type are governed by the index rule for this item.IndexRule
getIndexRule()
Gets theIndexRule
that defines how annotations matching this build item should be indexed.java.lang.String
getName()
Gets the name of the CAS type for which this item defines the indexing behavior.void
setFilter(Filter aFilter)
Sets theFilter
that identifies which instances of the named CAS type are governed by the index rule for this item.void
setIndexRule(IndexRule aRule)
Sets theIndexRule
that defines how annotations matching this build item should be indexed.void
setName(java.lang.String aName)
Sets 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 Detail
-
getName
java.lang.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
void setName(java.lang.String aName)
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 theIndexRule
that defines how annotations matching this build item should be indexed.- Returns:
- the indexing rule for this build item
-
setIndexRule
void setIndexRule(IndexRule aRule)
Sets theIndexRule
that defines how annotations matching this build item should be indexed.- Parameters:
aRule
- the indexing rule for this build item
-
getFilter
Filter getFilter()
Gets theFilter
that 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
void setFilter(Filter aFilter)
Sets theFilter
that 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
-
-