org.apache.uima.cas
Interface Feature

All Superinterfaces:
Comparable

public interface Feature
extends Comparable

The interface that describes features in the type system.

Feature short or base names are type system identifiers. The (fully) qualified name of a feature is the name of the type it is defined on, followed by a colon, followed by the its short name. For example, the qualified name of the Annotation begin feature is uima.tcas.Annotation:begin.


Method Summary
 Type getDomain()
          Get the domain type for this feature.
 String getName()
          Get the qualified name for this feature.
 Type getRange()
          Get the range type for this feature.
 String getShortName()
          Get the unqualified, short name of this feature.
 boolean isMultipleReferencesAllowed()
          Checks if there can be multiple references to values of this feature.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getDomain

Type getDomain()
Get the domain type for this feature.

Returns:
The domain type. This can not be null.

getRange

Type getRange()
Get the range type for this feature.

Returns:
The range type. This can not be null.

getName

String getName()
Get the qualified name for this feature.

Returns:
The name.

getShortName

String getShortName()
Get the unqualified, short name of this feature.

Returns:
The short name.

isMultipleReferencesAllowed

boolean isMultipleReferencesAllowed()
Checks if there can be multiple references to values of this feature. There can only be a single reference to a value of a feature if the value type is primitive, or if the feature is array valued and has been declared in the type system to not allow multiple references.

Returns:
true iff the value type of this feature is primitive, or if it's an array valued feature and has been declared not to allow multiple references.


Copyright © 2007 The Apache Software Foundation. All Rights Reserved.