Package org.apache.uima.cas.impl
Class FeatureImpl
- java.lang.Object
-
- org.apache.uima.cas.impl.FeatureImpl
-
- All Implemented Interfaces:
Comparable<Feature>
,Feature
public class FeatureImpl extends Object implements Feature
The implementation of features in the type system.- Version:
- $Revision: 1.4 $
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Feature o)
Note: you can only compare features from the same type system.int
getCode()
Type
getDomain()
Get the domain type for this feature.String
getName()
Get the name for this feature.Type
getRange()
Get the range type for this feature.String
getShortName()
Get the unqualified, short name of this feature.TypeSystem
getTypeSystem()
Get the type hierarchy that this feature belongs to.boolean
isMultipleReferencesAllowed()
Checks if there can be multiple references to values of this feature.String
toString()
-
-
-
Method Detail
-
getCode
public int getCode()
- Returns:
- the internal code of this feature. Necessary when using low-level APIs.-
-
getDomain
public Type getDomain()
Get the domain type for this feature.
-
getRange
public Type getRange()
Get the range type for this feature.
-
getName
public String getName()
Get the name for this feature.
-
getShortName
public String getShortName()
Description copied from interface:Feature
Get the unqualified, short name of this feature.- Specified by:
getShortName
in interfaceFeature
- Returns:
- The short name.
-
getTypeSystem
public TypeSystem getTypeSystem()
Get the type hierarchy that this feature belongs to.- Returns:
- The type hierarchy.
-
compareTo
public int compareTo(Feature o)
Note: you can only compare features from the same type system. If you compare features from different type systems, the result is undefined.- Specified by:
compareTo
in interfaceComparable<Feature>
-
isMultipleReferencesAllowed
public boolean isMultipleReferencesAllowed()
Description copied from interface:Feature
Checks if there can be multiple references to values of this feature. This is only meaningful for array-valued or list-values features.If this is false it indicates that this feature has exclusive ownership of the array or list, so changes to the array or list are localized. If this is true it indicates that the array or list may be shared, so changes to it may affect other objects in the CAS.
- Specified by:
isMultipleReferencesAllowed
in interfaceFeature
- Returns:
true
iff the value type of this feature is an array or list and has been declared to allow multiple references.
-
-