Package org.apache.uima.resource.metadata.impl

Class LanguagePrecondition_impl

java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.SimplePrecondition_impl
org.apache.uima.resource.metadata.impl.LanguagePrecondition_impl
All Implemented Interfaces:
Serializable, Cloneable, LanguagePrecondition, MetaDataObject, Precondition, SimplePrecondition, XMLizable
public class LanguagePrecondition_impl extends SimplePrecondition_impl implements LanguagePrecondition
Precondition that tests language of the document.
See Also:

  • Constructor Details

    • LanguagePrecondition_impl

      public LanguagePrecondition_impl()

  • Method Details

    • getLanguages

      public String[] getLanguages()
      Description copied from interface: LanguagePrecondition
      Gets the languages that satisfy this precondition. This will be an array of ISO language identifiers. For this precondition to be satisfied, the document's language must be subsumed by one of these identifiers (for example, en-GB is subsumed by en).

      Note that if the document's language is unknown, the value of the default property determines whether this precondition is satisfied.

      Specified by:
      getLanguages in interface LanguagePrecondition
      Returns:
      the languages that satisfy this precondition

    • setLanguages

      public void setLanguages(String... aLanguages)
      Description copied from interface: LanguagePrecondition
      Sets the languages that satisfy this precondition. This will be an array of ISO language identifiers. For this precondition to be satisfied, the document's language must be subsumed by one of these identifiers (for example, en-GB is subsumed by en).

      Note that if the document's language is unknown, the value of the default property determines whether this precondition is satisfied. The ISO language identifiers are cannonicalized by lower-casing them and replacing underscores with hyphens. Also, if any of the identifiers are x-unspecified, the array is replaced with an array of just one element: x-unspecified, since all languages are defined to match that one.

      Specified by:
      setLanguages in interface LanguagePrecondition
      Parameters:
      aLanguages - the languages that satisfy this precondition

    • setComparisonValue

      public void setComparisonValue(Object aValue)
      Description copied from interface: SimplePrecondition
      Sets the literal value to which features' values will be compared.
      Specified by:
      setComparisonValue in interface SimplePrecondition
      Overrides:
      setComparisonValue in class SimplePrecondition_impl
      Parameters:
      aValue - the comparison value, which must be a String, Integer, Float, Boolean, or an array of one of those four types.

    • setFeatureName

      public void setFeatureName(String aFeatureName)
      Description copied from interface: SimplePrecondition
      Sets the name of the feature to be tested.
      Specified by:
      setFeatureName in interface SimplePrecondition
      Overrides:
      setFeatureName in class SimplePrecondition_impl
      Parameters:
      aFeatureName - the feature name, null if none

    • setFsIndexName

      public void setFsIndexName(String aIndexName)
      Description copied from interface: SimplePrecondition
      Sets the name of the FeatureStructure index containing FeatureStructures to be tested by this precondition.
      Specified by:
      setFsIndexName in interface SimplePrecondition
      Overrides:
      setFsIndexName in class SimplePrecondition_impl
      Parameters:
      aIndexName - the name of the FS index, null if the default annotation index should be used

    • setFsMatchConstraint

      public void setFsMatchConstraint(FSMatchConstraint aConstraint)
      Description copied from interface: SimplePrecondition
      Sets the FSMatchConstraint that determines which CAS feature structures will be tested by this precondition.
      Specified by:
      setFsMatchConstraint in interface SimplePrecondition
      Overrides:
      setFsMatchConstraint in class SimplePrecondition_impl
      Parameters:
      aConstraint - the FS match constraint, null if none

    • setPredicate

      public void setPredicate(String aPredicate)
      Description copied from interface: SimplePrecondition
      Sets the predicate used to compare the test value to the comparison value.
      Specified by:
      setPredicate in interface SimplePrecondition
      Overrides:
      setPredicate in class SimplePrecondition_impl
      Parameters:
      aPredicate - a String that identifies the predicate used. This must match one of the constants defined on this interface.

    • equals

      public boolean equals(Object aObject)
      Description copied from class: MetaDataObject_impl
      Determines if this object is equal to another. Two MetaDataObjects are equivalent if they share the same attributes and the same values for those attributes.
      Specified by:
      equals in interface MetaDataObject
      Overrides:
      equals in class MetaDataObject_impl
      Parameters:
      aObject - object with which to compare this object
      Returns:
      true if and only if this object is equal to aObj

    • hashCode

      public int hashCode()
      Description copied from class: MetaDataObject_impl
      Gets the hash code for this object. The hash codes of two NameClassPairs x and y must be equal if x.equals(y) returns true;
      Overrides:
      hashCode in class MetaDataObject_impl
      Returns:
      the hash code for this object