Package org.apache.uima.cas.impl
Class TypeImpl
- java.lang.Object
-
- org.apache.uima.cas.impl.TypeImpl
-
- Direct Known Subclasses:
StringTypeImpl
public class TypeImpl extends java.lang.Object implements Type, java.lang.Comparable<TypeImpl>
The implementation of types in the type system.- Version:
- $Revision: 1.3 $
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
compareTo(TypeImpl t)
Note: you can only compare types from the same type system.java.util.Vector<Feature>
getAppropriateFeatures()
Deprecated.int
getCode()
Return the internal integer code for this type.Type
getComponentType()
For array types, returns the component type of the array type.Feature
getFeature(java.lang.String featureName)
Deprecated.Feature
getFeatureByBaseName(java.lang.String featureName)
Retrieve a feature for this type.java.util.List<Feature>
getFeatures()
guaranteed to be non-null, but might be empty listjava.lang.String
getName()
Get the name of the type.int
getNumberOfFeatures()
Get the number of features for which this type defines the range.java.lang.String
getShortName()
Get the unqualified, short name of this type.Type
getSuperType()
Get the super type.TypeSystem
getTypeSystem()
Get the type hierarchy that this type belongs to.boolean
isAnnotationType()
Check if this is an annotation type.boolean
isArray()
Check if the type is an array type.boolean
isFeatureFinal()
Check if type is feature final, i.e., if no more new features may be defined for it.boolean
isInheritanceFinal()
Check if type is inheritance final, i.e., if new types can be derived from it.boolean
isPrimitive()
Check if the type is one of the primitive types.java.lang.String
toString()
-
-
-
Method Detail
-
getName
public java.lang.String getName()
Get the name of the type.
-
getSuperType
public Type getSuperType()
Get the super type.- Returns:
- The super type or null for Top.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getAppropriateFeatures
@Deprecated public java.util.Vector<Feature> getAppropriateFeatures()
Deprecated.Get a vector of the features for which this type is the domain. Features will be returned in no particular order.- Specified by:
getAppropriateFeatures
in interfaceType
- Returns:
- The vector.
-
getNumberOfFeatures
public int getNumberOfFeatures()
Get the number of features for which this type defines the range.- Specified by:
getNumberOfFeatures
in interfaceType
- Returns:
- The number of features.
-
isAnnotationType
public boolean isAnnotationType()
Check if this is an annotation type.- Returns:
true
, ifthis
is an annotation type;false
, else.
-
getTypeSystem
public TypeSystem getTypeSystem()
Get the type hierarchy that this type belongs to.- Returns:
- The type hierarchy.
-
getCode
public int getCode()
Return the internal integer code for this type. This is only useful if you want to work with the low-level API.- Returns:
- The internal code for this type,
>=0
.
-
compareTo
public int compareTo(TypeImpl t)
Note: you can only compare types from the same type system. If you compare types from different type systems, the result is undefined.- Specified by:
compareTo
in interfacejava.lang.Comparable<TypeImpl>
-
getFeatureByBaseName
public Feature getFeatureByBaseName(java.lang.String featureName)
Description copied from interface:Type
Retrieve a feature for this type. Inherited features can also be retrieved this way.- Specified by:
getFeatureByBaseName
in interfaceType
- Parameters:
featureName
- The short, unqualified name of the feature.- Returns:
- The feature, if it exists;
null
, else. - See Also:
Type.getFeatureByBaseName(String)
-
getShortName
public java.lang.String getShortName()
Description copied from interface:Type
Get the unqualified, short name of this type.- Specified by:
getShortName
in interfaceType
- Returns:
- The short name of this type.
- See Also:
Type.getShortName()
-
isPrimitive
public boolean isPrimitive()
Description copied from interface:Type
Check if the type is one of the primitive types.- Specified by:
isPrimitive
in interfaceType
- Returns:
true
iff type is a primitive type.- See Also:
Type.isPrimitive()
-
isFeatureFinal
public boolean isFeatureFinal()
Description copied from interface:Type
Check if type is feature final, i.e., if no more new features may be defined for it.- Specified by:
isFeatureFinal
in interfaceType
- Returns:
- If type is feature final.
- See Also:
Type.isFeatureFinal()
-
isInheritanceFinal
public boolean isInheritanceFinal()
Description copied from interface:Type
Check if type is inheritance final, i.e., if new types can be derived from it.- Specified by:
isInheritanceFinal
in interfaceType
- Returns:
- If type is inheritance final.
- See Also:
Type.isInheritanceFinal()
-
getFeature
@Deprecated public Feature getFeature(java.lang.String featureName)
Deprecated.- Parameters:
featureName
- -- Returns:
- -
-
getFeatures
public java.util.List<Feature> getFeatures()
guaranteed to be non-null, but might be empty list- Specified by:
getFeatures
in interfaceType
- Returns:
- -
-
isArray
public boolean isArray()
Description copied from interface:Type
Check if the type is an array type.
-
getComponentType
public Type getComponentType()
Description copied from interface:Type
For array types, returns the component type of the array type. For all other types, it will returnnull
.- Specified by:
getComponentType
in interfaceType
- Returns:
- The component type of an array type.
-
-