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:
java.io.Serializable
,java.lang.Cloneable
,FsIndexKeyDescription
,MetaDataObject
,XMLizable
public class FsIndexKeyDescription_impl extends MetaDataObject_impl implements FsIndexKeyDescription
- See Also:
- Serialized Form
-
-
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 Modifier and Type Field Description (package private) static java.lang.String[]
COMPARATOR_STRINGS
String representations of comparator values used in XML import/export.private int
mComparator
private java.lang.String
mFeatureName
private boolean
mTypePriority
(package private) static long
serialVersionUID
private static XmlizationInfo
XMLIZATION_INFO
-
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
-
Fields inherited from interface org.apache.uima.resource.metadata.FsIndexKeyDescription
REVERSE_STANDARD_COMPARE, STANDARD_COMPARE
-
-
Constructor Summary
Constructors Constructor Description FsIndexKeyDescription_impl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getComparator()
Gets the comparator for this key.java.lang.String
getFeatureName()
Gets the name of the key's Feature.protected XmlizationInfo
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML.boolean
isTypePriority()
Gets whether this is a special "type priority" key.protected void
readPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, org.w3c.dom.Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions)
Overridden to handle XML import of thetypePriority
andcomparator
properties.void
setComparator(int aComparator)
Sets the comparator for this key.void
setFeatureName(java.lang.String aName)
Sets the name of the key's Feature.void
setTypePriority(boolean aTypePriority)
Gets whether this is a special "type priority" key.protected void
writePropertyAsElement(PropertyXmlInfo aPropInfo, java.lang.String aNamespace)
Overridden to handle XML export of thetypePriority
andcomparator
properties.-
Methods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributes, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getUnfilteredAttributes, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
-
Methods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
- See Also:
- Constant Field Values
-
COMPARATOR_STRINGS
static final java.lang.String[] COMPARATOR_STRINGS
String representations of comparator values used in XML import/export.
-
mTypePriority
private boolean mTypePriority
-
mFeatureName
private java.lang.String mFeatureName
-
mComparator
private int mComparator
-
XMLIZATION_INFO
private static final XmlizationInfo XMLIZATION_INFO
-
-
Method Detail
-
isTypePriority
public boolean isTypePriority()
Description copied from interface:FsIndexKeyDescription
Gets whether this is a special "type priority" key. A type priority key indicates that the ordering of FeatureStructures in the index is based on theTypePriorities
defined for that Analysis Engine.Type priority keys ignore any values assigned to the
featureName
andcomparator
properties.- Specified by:
isTypePriority
in interfaceFsIndexKeyDescription
- Returns:
- true if and only if this is a type priority key
- See Also:
FsIndexKeyDescription.isTypePriority()
-
setTypePriority
public void setTypePriority(boolean aTypePriority)
Description copied from interface:FsIndexKeyDescription
Gets whether this is a special "type priority" key. A type priority key indicates that the ordering of FeatureStructures in the index is based on theTypePriorities
defined for that Analysis Engine.Type priority keys ignore any values assigned to the
featureName
andcomparator
properties.- Specified by:
setTypePriority
in interfaceFsIndexKeyDescription
- Parameters:
aTypePriority
- true if and only if this is a type priority key- See Also:
FsIndexKeyDescription.setTypePriority(boolean)
-
getFeatureName
public java.lang.String getFeatureName()
Description copied from interface:FsIndexKeyDescription
Gets the name of the key's Feature. FeatureStructures will be ordered in the index based on the value of this Feature.- Specified by:
getFeatureName
in interfaceFsIndexKeyDescription
- Returns:
- the name of this key's Feature
- See Also:
FsIndexKeyDescription.getFeatureName()
-
setFeatureName
public void setFeatureName(java.lang.String aName)
Description copied from interface:FsIndexKeyDescription
Sets the name of the key's Feature. FeatureStructures will be ordered in the index based on the value of this Feature.- Specified by:
setFeatureName
in interfaceFsIndexKeyDescription
- Parameters:
aName
- the name of this key's Feature- See Also:
FsIndexKeyDescription.setFeatureName(String)
-
getComparator
public int getComparator()
Description copied from interface:FsIndexKeyDescription
Gets 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:
getComparator
in interfaceFsIndexKeyDescription
- Returns:
- this key's comparator
- See Also:
FsIndexKeyDescription.getComparator()
-
setComparator
public void setComparator(int aComparator)
Description copied from interface:FsIndexKeyDescription
Sets 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:
setComparator
in interfaceFsIndexKeyDescription
- Parameters:
aComparator
- this key's comparator- See Also:
FsIndexKeyDescription.setComparator(int)
-
writePropertyAsElement
protected void writePropertyAsElement(PropertyXmlInfo aPropInfo, java.lang.String aNamespace) throws org.xml.sax.SAXException
Overridden to handle XML export of thetypePriority
andcomparator
properties.- Overrides:
writePropertyAsElement
in classMetaDataObject_impl
- Parameters:
aPropInfo
- information on how to represent the property in XMLaNamespace
- XML namespace URI for this object representation- Throws:
org.xml.sax.SAXException
- -- See Also:
MetaDataObject_impl.writePropertyAsElement(PropertyXmlInfo, String)
-
readPropertyValueFromXMLElement
protected void readPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, org.w3c.dom.Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException
Overridden to handle XML import of thetypePriority
andcomparator
properties.- Overrides:
readPropertyValueFromXMLElement
in 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:
MetaDataObject_impl.readPropertyValueFromXMLElement(PropertyXmlInfo, Element, XMLParser, org.apache.uima.util.XMLParser.ParsingOptions)
-
getXmlizationInfo
protected XmlizationInfo getXmlizationInfo()
Description copied from class:MetaDataObject_impl
To be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfo
in classMetaDataObject_impl
- Returns:
- information defining this object's XML representation
-
-