Package org.apache.uima.analysis_engine
Interface TypeOrFeature
- All Superinterfaces:
Cloneable,Comparable<TypeOrFeature>,MetaDataObject,Serializable,XMLizable
- All Known Implementing Classes:
TypeOrFeature_impl
A reference to a Type or Feature in the Analysis Engine's TypeSystem. This interface is used by
Capability to declare which Types and Features the
Analysis Engine inputs and outputs, and it is also used by ResultSpecification to declare
the outputs that are desired by the application.-
Method Summary
Modifier and TypeMethodDescriptiongetName()Gets the fully-qualified Type or Feature name.booleanFor Type references, this method determines whether this reference should be considered to also refer to all features of the Type that are known to the annotator.booleanisType()Gets whether this object refers to a Type or to a Feature.voidsetAllAnnotatorFeatures(boolean aAllAnnotatorFeatures) For Type references, sets whether this reference should be considered to also refer to all features of the Type that are known to the annotator.voidSets the fully-qualified Type or Feature name.voidsetType(boolean aType) Sets whether this object refers to a Type or to a Feature.Methods inherited from interface java.lang.Comparable
compareToMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
isType
boolean isType()Gets whether this object refers to a Type or to a Feature.- Returns:
- true if Type, false if Feature
-
setType
void setType(boolean aType) Sets whether this object refers to a Type or to a Feature.- Parameters:
aType- true if Type, false if Feature
-
getName
String getName()Gets the fully-qualified Type or Feature name.- Returns:
- the fully-qualified name
-
setName
Sets the fully-qualified Type or Feature name.- Parameters:
aName- the fully-qualified name
-
isAllAnnotatorFeatures
boolean isAllAnnotatorFeatures()For Type references, this method determines whether this reference should be considered to also refer to all features of the Type that are known to the annotator. This field is not used for Feature references.- Returns:
- true if this is a reference to all features, false if it is only a reference to the type
-
setAllAnnotatorFeatures
void setAllAnnotatorFeatures(boolean aAllAnnotatorFeatures) For Type references, sets whether this reference should be considered to also refer to all features of the Type that are known to the annotator. This field is not used for Feature references.- Parameters:
aAllAnnotatorFeatures- true if this is a reference to all features, false if it is only a reference to the type
-