Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.uima.cas
Interface FeaturePath

    public interface FeaturePath

Interface for a feature path. A feature path is a sequence of `Feature`s that are used with constraint tests to specify how to get the value to test, starting from a given feature structure. To use:

- create an empty feature path using `CAS.createFeaturePath()`
- add one or more features to it, representing the chain of features to follow to get to the value to test, using `addFeature(Feature)`
- hook up this feature path with a particular constraint test, using `ConstraintFactory.embedConstraint(FeaturePath, FSConstraint)`.

Method Summary
`void` | `addFeature(Feature feat)` Add a new feature at the end of the path.
`Feature` | `getFeature(int i)` Get feature at position.
`int` | `size()` Get length of path.

Method Detail

### size

    int size()

  Get length of path.

  Returns:
    An integer `>= 0`.

### getFeature

    Feature getFeature(int i)

  Get feature at position.

  Parameters:
    `i` - The position in the path (starting at `0`).
  Returns:
    The feature, or `null` if there is no such feature.

### addFeature

    void addFeature(Feature feat)

  Add a new feature at the end of the path.

  Parameters:
    `feat` - The feature to be added.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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