ContainingConstraint (Apache OpenNLP UIMA Annotators 2.5.9 API)
Description: declaration: package: opennlp.uima.util, class: ContainingConstraint

# Class ContainingConstraint

java.lang.Object
opennlp.uima.util.ContainingConstraint

All Implemented Interfaces:
  `Serializable, org.apache.uima.cas.FSConstraint, org.apache.uima.cas.FSMatchConstraint`

public final class ContainingConstraint extends Object implements org.apache.uima.cas.FSMatchConstraint
Checks if an `AnnotationFS` is contained by the given AnnotationFS.

See Also:
  - Serialized Form

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ContainingConstraint()`
  Initializes a `ContainingConstraint`.
  `ContainingConstraint(org.apache.uima.cas.text.AnnotationFS containingAnnotation)`
  Initializes a `ContainingConstraint`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `match(org.apache.uima.cas.FeatureStructure featureStructure)`
  Checks if the given `FeatureStructure` matches the constraint.

  ### Methods inherited from class Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### ContainingConstraint

    public ContainingConstraint()
    Initializes a `ContainingConstraint`.

  - ### ContainingConstraint

    public ContainingConstraint(org.apache.uima.cas.text.AnnotationFS containingAnnotation)
    Initializes a `ContainingConstraint`.
    Parameters:
      `containingAnnotation` - The `AnnotationFS` to initialize with.

- ## Method Details

  - ### match

    public boolean match(org.apache.uima.cas.FeatureStructure featureStructure)
    Checks if the given `FeatureStructure` matches the constraint.
    Specified by:
      `match` in interface `org.apache.uima.cas.FSMatchConstraint`