Package org.apache.uima.cas

# Interface FSMatchConstraint

All Superinterfaces:
  `FSConstraint`, `Serializable`

All Known Subinterfaces:
  `FSTypeConstraint`

All Known Implementing Classes:
  `BooleanConstraint`

public interface FSMatchConstraint extends FSConstraint, Serializable
Interface for feature structure matching constraints. These constraints are created as the result of combining primitive constraints with a "path" that specifies how to find the value to test, starting with a feature structure instance, and specifying which feature (or possibly a chain of features) to use as the value, using the `ConstraintFactory.embedConstraint(FeaturePath, FSConstraint)` method. These constraints are also produced by "anding" and "oring" together other instances of these constraints.

To use the constraint, invoke its `match(FeatureStructure)` method, passing the feature structure to test.

You can also use these constraints to construct a `CAS.createFilteredIterator(FSIterator, FSMatchConstraint)`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `match(FeatureStructure fs)`
  Match against feature structures.

- ## Method Details

  - ### match

    boolean match(FeatureStructure fs)
    Match against feature structures.
    Parameters:
      `fs` - The feature structure we want to match.
    Returns:
      -