Class FsIndexKeyDescription_impl
java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.FsIndexKeyDescription_impl
- All Implemented Interfaces:
Serializable,Cloneable,FsIndexKeyDescription,MetaDataObject,XMLizable
public class FsIndexKeyDescription_impl
extends MetaDataObject_impl
implements FsIndexKeyDescription
- 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.FsIndexKeyDescription
REVERSE_STANDARD_COMPARE, STANDARD_COMPARE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintGets the comparator for this key.Gets the name of the key's Feature.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.booleanGets whether this is a special "type priority" key.protected voidreadPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Overridden to handle XML import of thetypePriorityandcomparatorproperties.voidsetComparator(int aComparator) Sets the comparator for this key.voidsetFeatureName(String aName) Sets the name of the key's Feature.voidsetTypePriority(boolean aTypePriority) Gets whether this is a special "type priority" key.protected voidwritePropertyAsElement(PropertyXmlInfo aPropInfo, String aNamespace) Overridden to handle XML export of thetypePriorityandcomparatorproperties.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, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXmlMethods 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
-
FsIndexKeyDescription_impl
public FsIndexKeyDescription_impl()
-
-
Method Details
-
isTypePriority
public boolean isTypePriority()Description copied from interface:FsIndexKeyDescriptionGets whether this is a special "type priority" key. A type priority key indicates that the ordering of FeatureStructures in the index is based on theTypePrioritiesdefined for that Analysis Engine.Type priority keys ignore any values assigned to the
featureNameandcomparatorproperties.- Specified by:
isTypePriorityin interfaceFsIndexKeyDescription- Returns:
- true if and only if this is a type priority key
- See Also:
-
setTypePriority
public void setTypePriority(boolean aTypePriority) Description copied from interface:FsIndexKeyDescriptionGets whether this is a special "type priority" key. A type priority key indicates that the ordering of FeatureStructures in the index is based on theTypePrioritiesdefined for that Analysis Engine.Type priority keys ignore any values assigned to the
featureNameandcomparatorproperties.- Specified by:
setTypePriorityin interfaceFsIndexKeyDescription- Parameters:
aTypePriority- true if and only if this is a type priority key- See Also:
-
getFeatureName
Description copied from interface:FsIndexKeyDescriptionGets the name of the key's Feature. FeatureStructures will be ordered in the index based on the value of this Feature.- Specified by:
getFeatureNamein interfaceFsIndexKeyDescription- Returns:
- the name of this key's Feature
- See Also:
-
setFeatureName
Description copied from interface:FsIndexKeyDescriptionSets the name of the key's Feature. FeatureStructures will be ordered in the index based on the value of this Feature.- Specified by:
setFeatureNamein interfaceFsIndexKeyDescription- Parameters:
aName- the name of this key's Feature- See Also:
-
getComparator
public int getComparator()Description copied from interface:FsIndexKeyDescriptionGets the comparator for this key. This determines the ordering of FeatureStructures in the index. Valid values for this property are defined by constants on this interface.- Specified by:
getComparatorin interfaceFsIndexKeyDescription- Returns:
- this key's comparator
- See Also:
-
setComparator
public void setComparator(int aComparator) Description copied from interface:FsIndexKeyDescriptionSets the comparator for this key. This determines the ordering of FeatureStructures in the index. Valid values for this property are defined by constants on this interface.- Specified by:
setComparatorin interfaceFsIndexKeyDescription- Parameters:
aComparator- this key's comparator- See Also:
-
writePropertyAsElement
protected void writePropertyAsElement(PropertyXmlInfo aPropInfo, String aNamespace) throws SAXException Overridden to handle XML export of thetypePriorityandcomparatorproperties.- Overrides:
writePropertyAsElementin classMetaDataObject_impl- Parameters:
aPropInfo- information on how to represent the property in XMLaNamespace- XML namespace URI for this object representation- Throws:
SAXException- -- See Also:
-
readPropertyValueFromXMLElement
protected void readPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException Overridden to handle XML import of thetypePriorityandcomparatorproperties.- Overrides:
readPropertyValueFromXMLElementin classMetaDataObject_impl- Parameters:
aPropXmlInfo- information about the property to readaElement- DOM element to read fromaParser- parser to use to construct complex valuesaOptions- option settings- Throws:
InvalidXMLException- -- See Also:
-
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
-