Class SimplePrecondition_impl
java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.SimplePrecondition_impl
- All Implemented Interfaces:
Serializable,Cloneable,MetaDataObject,Precondition,SimplePrecondition,XMLizable
- Direct Known Subclasses:
LanguagePrecondition_impl,MimeTypePrecondition_impl
Reference implementation of
SimplePrecondition.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer -
Field Summary
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContextFields inherited from interface org.apache.uima.resource.metadata.SimplePrecondition
ELEMENT_OF, EQUAL, LANGUAGE_SUBSUMED, PRECONDITION_TYPE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanDetermines if this precondition is satisfied by a CAS.Retrieves the literal value to which features' values will be compared.booleanRetrieves the default value for this precondition.Gets the name of the feature to be tested.Retrieves the name of the FeatureStructure index containing FeatureStructures to be tested by this precondition.Retrieves the FSMatchConstraint that determines which CAS feature structures will be tested by this precondition.Gets the type of this precondition.Retrieves the predicate used to compare the test value to the comparison value.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.protected static booleanisValidPredicateName(Object aName) Determines whether the given String is a valid name a predicate defined by this class.voidsetComparisonValue(Object aValue) Sets the literal value to which features' values will be compared.voidsetDefault(boolean aDefault) Sets the default value for this precondition.voidsetFeatureName(String aFeatureName) Sets the name of the feature to be tested.voidsetFsIndexName(String aIndexName) Sets the name of the FeatureStructure index containing FeatureStructures to be tested by this precondition.voidsetFsMatchConstraint(FSMatchConstraint aConstraint) Sets the FSMatchConstraint that determines which CAS feature structures will be tested by this precondition.voidsetPredicate(String aPredicate) Sets the predicate used to compare the test value to the comparison value.Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElementMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Constructor Details
-
SimplePrecondition_impl
public SimplePrecondition_impl()
-
-
Method Details
-
getPreconditionType
Description copied from interface:SimplePreconditionGets the type of this precondition. Each sub-interface ofPreconditionhas its own standard type identifier String. These identifier Strings are used instead of Java class names in order to ease portability of metadata to other languages.- Specified by:
getPreconditionTypein interfacePrecondition- Specified by:
getPreconditionTypein interfaceSimplePrecondition- Returns:
SimplePrecondition.PRECONDITION_TYPE- See Also:
-
getDefault
public boolean getDefault()Description copied from interface:SimplePreconditionRetrieves the default value for this precondition. This is the value returned if there is no applicable test value in the CAS.- Specified by:
getDefaultin interfaceSimplePrecondition- Returns:
- the default value
- See Also:
-
getFeatureName
Description copied from interface:SimplePreconditionGets the name of the feature to be tested.- Specified by:
getFeatureNamein interfaceSimplePrecondition- Returns:
- the feature name,
nullif none - See Also:
-
getFsIndexName
Description copied from interface:SimplePreconditionRetrieves the name of the FeatureStructure index containing FeatureStructures to be tested by this precondition.- Specified by:
getFsIndexNamein interfaceSimplePrecondition- Returns:
- the name of the FS index,
nullif the default annotation index should be used - See Also:
-
getFsMatchConstraint
Description copied from interface:SimplePreconditionRetrieves the FSMatchConstraint that determines which CAS feature structures will be tested by this precondition.- Specified by:
getFsMatchConstraintin interfaceSimplePrecondition- Returns:
- the FS match constraint,
nullif none - See Also:
-
setDefault
public void setDefault(boolean aDefault) Description copied from interface:SimplePreconditionSets the default value for this precondition. This is the value returned if there is no applicable test value in the CAS.- Specified by:
setDefaultin interfaceSimplePrecondition- Parameters:
aDefault- the default value- See Also:
-
setFeatureName
Description copied from interface:SimplePreconditionSets the name of the feature to be tested.- Specified by:
setFeatureNamein interfaceSimplePrecondition- Parameters:
aFeatureName- the feature name,nullif none- See Also:
-
setFsIndexName
Description copied from interface:SimplePreconditionSets the name of the FeatureStructure index containing FeatureStructures to be tested by this precondition.- Specified by:
setFsIndexNamein interfaceSimplePrecondition- Parameters:
aIndexName- the name of the FS index,nullif the default annotation index should be used- See Also:
-
setFsMatchConstraint
Description copied from interface:SimplePreconditionSets the FSMatchConstraint that determines which CAS feature structures will be tested by this precondition.- Specified by:
setFsMatchConstraintin interfaceSimplePrecondition- Parameters:
aConstraint- the FS match constraint,nullif none- See Also:
-
evaluate
Description copied from interface:PreconditionDetermines if this precondition is satisfied by a CAS.- Specified by:
evaluatein interfacePrecondition- Parameters:
aCAS- the CAS against which to evaluate this precondition- Returns:
- true if and only if the CAS satisfies this precondition.
- See Also:
-
getComparisonValue
Description copied from interface:SimplePreconditionRetrieves the literal value to which features' values will be compared.- Specified by:
getComparisonValuein interfaceSimplePrecondition- Returns:
- the value, which must be a String, Integer, Float, Boolean or an array of one of those four types.
- See Also:
-
setComparisonValue
Description copied from interface:SimplePreconditionSets the literal value to which features' values will be compared.- Specified by:
setComparisonValuein interfaceSimplePrecondition- Parameters:
aValue- the comparison value, which must be a String, Integer, Float, Boolean, or an array of one of those four types.- See Also:
-
getPredicate
Description copied from interface:SimplePreconditionRetrieves the predicate used to compare the test value to the comparison value.- Specified by:
getPredicatein interfaceSimplePrecondition- Returns:
- a String that identifies the predicate used. This will always match one of the constants defined on this interface.
- See Also:
-
setPredicate
Description copied from interface:SimplePreconditionSets the predicate used to compare the test value to the comparison value.- Specified by:
setPredicatein interfaceSimplePrecondition- Parameters:
aPredicate- a String that identifies the predicate used. This must match one of the constants defined on this interface.- See Also:
-
isValidPredicateName
Determines whether the given String is a valid name a predicate defined by this class. Valid predicate names are legal arguments to thesetPredicate(String)method, and are defined by constants on theSimplePreconditioninterface.- Parameters:
aName- an Object to test- Returns:
- true if and only if
aNameis aStringthat is a valid predicate name.
-
getXmlizationInfo
Description copied from class:MetaDataObject_implTo be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfoin classMetaDataObject_impl- Returns:
- information defining this object's XML representation
-