Interface LanguagePrecondition
- All Superinterfaces:
Cloneable,MetaDataObject,Precondition,Serializable,SimplePrecondition,XMLizable
- All Known Implementing Classes:
LanguagePrecondition_impl
A precondition on the language of the document. This interface is a kind of
SimplePrecondition to be used as a convenience.-
Field Summary
Fields inherited from interface org.apache.uima.resource.metadata.SimplePrecondition
ELEMENT_OF, EQUAL, LANGUAGE_SUBSUMED, PRECONDITION_TYPE -
Method Summary
Modifier and TypeMethodDescriptionString[]Gets the languages that satisfy this precondition.voidsetLanguages(String[] aLanguages) Sets the languages that satisfy this precondition.Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.resource.metadata.Precondition
evaluateMethods inherited from interface org.apache.uima.resource.metadata.SimplePrecondition
getComparisonValue, getDefault, getFeatureName, getFsIndexName, getFsMatchConstraint, getPreconditionType, getPredicate, setComparisonValue, setDefault, setFeatureName, setFsIndexName, setFsMatchConstraint, setPredicateMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
getLanguages
String[] getLanguages()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
defaultproperty determines whether this precondition is satisfied.- Returns:
- the languages that satisfy this precondition
-
setLanguages
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
defaultproperty 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.- Parameters:
aLanguages- the languages that satisfy this precondition- Throws:
UIMA_UnsupportedOperationException- if thisMetaDataObjectis not modifiable.
-