# Uses of Interface
org.apache.uima.cas.Feature

Packages that use Feature
Package
Description
org.apache.uima.analysis_engine.impl
org.apache.uima.cas
Common Analysis System(CAS) Interfaces
org.apache.uima.cas.admin
org.apache.uima.cas.impl
Implementation and Low-Level API for the CAS Interfaces.
org.apache.uima.jcas
Interfaces for accessing the JCAS.
org.apache.uima.jcas.cas
JCAS model for built-in CAS types
org.apache.uima.jcas.impl
Provides the classes that support the Java Cas Model (JCM).
org.apache.uima.util
Utility classes and interfaces used by UIMA components.

- ## Uses of Feature in org.apache.uima.analysis_engine.impl

  Fields in org.apache.uima.analysis_engine.impl with type parameters of type Feature
  Modifier and Type
  Field
  Description
  `static final List<Feature>`
  RsType.`EMPTY_FEATURE_LIST`

- ## Uses of Feature in org.apache.uima.cas

  Methods in org.apache.uima.cas that return Feature
  Modifier and Type
  Method
  Description
  `Feature`
  CAS.`getBeginFeature()`
  Get the feature object for the annotation begin feature.
  `Feature`
  CAS.`getEndFeature()`
  Get the feature object for the annotation end feature.
  `Feature`
  FeaturePath.`getFeature(int i)`
  Get feature at position.
  `Feature`
  Type.`getFeatureByBaseName(String featureName)`
  Retrieve a feature for this type.
  `Feature`
  TypeSystem.`getFeatureByFullName(String featureName)`
  Get a feature object for a given name.
  Methods in org.apache.uima.cas that return types with arguments of type Feature
  Modifier and Type
  Method
  Description
  `Vector<Feature>`
  Type.`getAppropriateFeatures()`
  Deprecated.
  Use `getFeatures()` instead.
  `List<Feature>`
  Type.`getFeatures()`
  Get a vector of the features for which this type is a subtype of the features' domain (i.e., inherited features are also returned).
  `Iterator<Feature>`
  TypeSystem.`getFeatures()`
  Get a list of features, in no particular order.
  Methods in org.apache.uima.cas with parameters of type Feature
  Modifier and Type
  Method
  Description
  `void`
  FeaturePath.`addFeature(Feature feat)`
  Add a new feature at the end of the path.
  `boolean`
  FeatureStructure.`getBooleanValue(Feature feat)`
  Get the boolean value of a feature.
  `byte`
  FeatureStructure.`getByteValue(Feature feat)`
  Get the byte value of a feature.
  `double`
  FeatureStructure.`getDoubleValue(Feature feat)`
  Get the double value of a feature.
  `FeatureStructure`
  FeatureStructure.`getFeatureValue(Feature feat)`
  Get a feature value.
  `String`
  FeatureStructure.`getFeatureValueAsString(Feature feat)`
  Get the value of the feature as a string if the type of the feature is one of the primitive type.
  `float`
  FeatureStructure.`getFloatValue(Feature feat)`
  Get the float value of a feature.
  `int`
  FeatureStructure.`getIntValue(Feature feat)`
  Get the int value of a feature.
  `long`
  FeatureStructure.`getLongValue(Feature feat)`
  Get the long value of a feature.
  `short`
  FeatureStructure.`getShortValue(Feature feat)`
  Get the short value of a feature.
  `String`
  FeatureStructure.`getStringValue(Feature f)`
  Get the string value under a feature.
  `void`
  FeatureStructure.`setBooleanValue(Feature feat, boolean i)`
  Set the boolean value of a feature.
  `void`
  FeatureStructure.`setByteValue(Feature feat, byte i)`
  Set the byte (8 bit) value of a feature.
  `void`
  FeatureStructure.`setDoubleValue(Feature feat, double i)`
  Set the double value of a feature.
  `void`
  FeatureStructure.`setFeatureValue(Feature feat, FeatureStructure fs)`
  Set a feature value to another FS.
  `void`
  FeatureStructure.`setFeatureValueFromString(Feature feat, String s)`
  Sets the value of a feature from a string input if the feature type is one of the primitive types.
  `void`
  FeatureStructure.`setFloatValue(Feature feat, float f)`
  Set the float value of a feature.
  `void`
  FeatureStructure.`setIntValue(Feature feat, int i)`
  Set the int value of a feature.
  `void`
  FeatureStructure.`setLongValue(Feature feat, long i)`
  Set the long (64 bit) value of a feature.
  `void`
  FeatureStructure.`setShortValue(Feature feat, short i)`
  Set the short (16 bit) value of a feature.
  `void`
  FeatureStructure.`setStringValue(Feature feat, String s)`
  Set the string value of a feature.

- ## Uses of Feature in org.apache.uima.cas.admin

  Methods in org.apache.uima.cas.admin that return Feature
  Modifier and Type
  Method
  Description
  `Feature`
  TypeSystemMgr.`addFeature(String featureName, Type domainType, Type rangeType)`
  Add an feature to the type system.
  `Feature`
  TypeSystemMgr.`addFeature(String featureName, Type domainType, Type rangeType, boolean multipleReferencesAllowed)`
  Add an feature to the type system.
  `Feature`
  FSIndexComparator.`getKeyFeature(int key)`
  Get the feature for this key.
  Methods in org.apache.uima.cas.admin with parameters of type Feature
  Modifier and Type
  Method
  Description
  `int`
  FSIndexComparator.`addKey(Feature feat, int compareKey)`
  Add a new key.

- ## Uses of Feature in org.apache.uima.cas.impl

  Classes in org.apache.uima.cas.impl that implement Feature
  Modifier and Type
  Class
  Description
  `class`
  `FeatureImpl`
  The implementation of features in the type system.
  `class`
  `FeatureImpl_jcas_only`
  The implementation of jcas-only features in the type system.
  Methods in org.apache.uima.cas.impl that return Feature
  Modifier and Type
  Method
  Description
  `Feature`
  TypeSystemImpl.`addFeature(String featureName, Type domainType, Type rangeType)`
  `Feature`
  TypeSystemImpl.`addFeature(String shortFeatName, Type domainType, Type rangeType, boolean multipleReferencesAllowed)`
  `Feature`
  CASImpl.`getBeginFeature()`
  `Feature`
  CASImpl.`getEndFeature()`
  `Feature`
  TypeImpl.`getFeature(String featureName)`
  Deprecated.
  use getFeatureByBaseName instead
  `Feature`
  TypeSystemImpl.`getFeature(String featureName)`
  Deprecated.
  `Feature`
  LowLevelTypeSystem.`ll_getFeatureForCode(int featureCode)`
  Get a feature object for a given code.
  `Feature`
  TypeSystemImpl.`ll_getFeatureForCode(int featureCode)`
  Methods in org.apache.uima.cas.impl that return types with arguments of type Feature
  Modifier and Type
  Method
  Description
  `Vector<Feature>`
  TypeImpl.`getAppropriateFeatures()`
  Deprecated.
  use `TypeImpl.getFeatures()`
  `List<Feature>`
  TypeImpl.`getFeatures()`
  guaranteed to be non-null, but might be empty list
  `Iterator<Feature>`
  TypeSystemImpl.`getFeatures()`
  `Vector<Feature>`
  TypeSystemImpl.`getIntroFeatures(Type type)`
  `Iterator<Feature>`
  TypeImpl.`iterator()`
  Methods in org.apache.uima.cas.impl with parameters of type Feature
  Modifier and Type
  Method
  Description
  `int`
  FSIndexComparatorImpl.`addKey(Feature feat, int compareKey)`
  `final void`
  CASImpl.`checkTypingConditions(Type domType, Type ranType, Feature feat)`
  Check the range is appropriate for this type/feature.
  `int`
  FeatureImpl.`compareTo(Feature o)`
  This should work across different type systems, for instance when using filtered serialization
  `boolean`
  FeatureStructureImplC.`getBooleanValue(Feature feat)`
  G E T T E R S (The array getters are part of the Classes for the built-in arrays, here are only the non-array ones) getXyzValue(Feature feat) - this is the standard from V2 plain API - it does validity checking (normally) that the feature belongs to the type getXyzValueNc(FeatureImpl feat) - skips the validity checking that the feature belongs to the type.
  `byte`
  FeatureStructureImplC.`getByteValue(Feature feat)`
  `double`
  FeatureStructureImplC.`getDoubleValue(Feature feat)`
  `TOP`
  FeatureStructureImplC.`getFeatureValue(Feature feat)`
  `String`
  FeatureStructureImplC.`getFeatureValueAsString(Feature feat)`
  `float`
  FeatureStructureImplC.`getFloatValue(Feature feat)`
  `int`
  FeatureStructureImplC.`getIntValue(Feature feat)`
  `long`
  FeatureStructureImplC.`getLongValue(Feature feat)`
  `short`
  FeatureStructureImplC.`getShortValue(Feature feat)`
  `String`
  FeatureStructureImplC.`getStringValue(Feature feat)`
  `boolean`
  TypeImpl.`isAppropriateFeature(Feature feature)`
  `int`
  LowLevelTypeSystem.`ll_getCodeForFeature(Feature feature)`
  Get the code for a given feature object.
  `int`
  TypeSystemImpl.`ll_getCodeForFeature(Feature feature)`
  `FeatureImpl`
  TypeSystemImpl.`refreshFeature(Feature f)`
  `void`
  FeatureStructureImplC.`setBooleanValue(Feature feat, boolean v)`
  `void`
  FeatureStructureImplC.`setByteValue(Feature feat, byte v)`
  `void`
  FeatureStructureImplC.`setDoubleValue(Feature feat, double v)`
  `void`
  FeatureStructureImplC.`setFeatureValue(Feature feat, FeatureStructure v)`
  `void`
  FeatureStructureImplC.`setFeatureValueFromString(Feature feat, String s)`
  `void`
  FeatureStructureImplC.`setFloatValue(Feature feat, float v)`
  `void`
  FeatureStructureImplC.`setIntValue(Feature feat, int v)`
  `void`
  FeatureStructureImplC.`setLongValue(Feature feat, long v)`
  `void`
  FeatureStructureImplC.`setShortValue(Feature feat, short v)`
  `void`
  FeatureStructureImplC.`setStringValue(Feature feat, String v)`
  `Runnable`
  CasCompare.`sort_dedup_FSArray(TOP fs, Feature feat)`
  This is an optional pre-compare operation.
  Method parameters in org.apache.uima.cas.impl with type arguments of type Feature
  Modifier and Type
  Method
  Description
  `void`
  CasCompare.`applyToTypeFeature(String typeName, String featureBaseName, org.apache.uima.internal.util.function.Consumer2<TOP,Feature> c)`
  Before comparing, you can adjust specific features of specific types, arbitrarily.
  `List<Runnable>`
  CasCompare.`type_feature_to_runnable(String typeName, String featureBaseName, BiFunction<TOP,Feature,Runnable> c)`
  Before comparing, you can create pending values for specific types / features, and return a list of runnables, which when run, plug in those pending values.

- ## Uses of Feature in org.apache.uima.jcas

  Methods in org.apache.uima.jcas that return Feature
  Modifier and Type
  Method
  Description
  `Feature`
  JCas.`getRequiredFeature(Type t, String s)`
  `default Feature`
  JCas.`getRequiredFeatureDE(Type t, String s, String rangeName, boolean featOkTst)`
  Deprecated.

- ## Uses of Feature in org.apache.uima.jcas.cas

  Methods in org.apache.uima.jcas.cas with parameters of type Feature
  Modifier and Type
  Method
  Description
  `void`
  AnnotationBase.`setFeatureValue(Feature feat, FeatureStructure v)`
  `void`
  Sofa.`setFeatureValue(Feature feat, FeatureStructure fs)`
  `void`
  Sofa.`setIntValue(Feature feat, Integer val)`
  `void`
  Sofa.`setStringValue(Feature feat, String val)`

- ## Uses of Feature in org.apache.uima.jcas.impl

  Methods in org.apache.uima.jcas.impl that return Feature
  Modifier and Type
  Method
  Description
  `Feature`
  JCasImpl.`getRequiredFeature(Type t, String s)`

- ## Uses of Feature in org.apache.uima.util

  Methods in org.apache.uima.util with parameters of type Feature
  Modifier and Type
  Method
  Description
  `static FeatureDescription`
  TypeSystemUtil.`feature2FeatureDescription(Feature aFeature)`
  Convert a `Feature` to an equivalent `FeatureDescription`.