Class FsIndexDescription_impl
java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.FsIndexDescription_impl
- All Implemented Interfaces:
Serializable,Cloneable,FsIndexDescription,MetaDataObject,XMLizable
- 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.FsIndexDescription
EMPTY_FS_INDEX_DESCRIPTIONS, KIND_BAG, KIND_SET, KIND_SORTED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetKeys()Gets the keys for this index.getKind()Gets the "kind" of index.getLabel()Gets the label of this index.Gets the Type name for this index.protected Stringprotected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.voidsetKeys(FsIndexKeyDescription[] aKeys) Sets the keys for this index.voidSets the "kind" of index.voidSets the label of this index.voidsetTypeName(String aTypeName) Sets the Type name for this index.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
-
FsIndexDescription_impl
public FsIndexDescription_impl()
-
-
Method Details
-
getXMLElementTagName
-
getLabel
Description copied from interface:FsIndexDescriptionGets the label of this index. This is the identifier used to retrieve the index from the CAS's Index Repository.- Specified by:
getLabelin interfaceFsIndexDescription- Returns:
- the label of this index.
- See Also:
-
setLabel
Description copied from interface:FsIndexDescriptionSets the label of this index. This is the identifier used to retrieve the index from the CAS's Index Repository.- Specified by:
setLabelin interfaceFsIndexDescription- Parameters:
aLabel- the label of this index.- See Also:
-
getTypeName
Description copied from interface:FsIndexDescriptionGets the Type name for this index. This determines what type of FeatureStructures are contained in the index.- Specified by:
getTypeNamein interfaceFsIndexDescription- Returns:
- the type name for this index
- See Also:
-
setTypeName
Description copied from interface:FsIndexDescriptionSets the Type name for this index. This determines what type of FeatureStructures are contained in the index.- Specified by:
setTypeNamein interfaceFsIndexDescription- Parameters:
aTypeName- the type name for this index- See Also:
-
getKind
Description copied from interface:FsIndexDescriptionGets the "kind" of index. There are currently three kinds of indexes - "sorted", "set", and "bag" (seeFSIndexfor definitions). If this isnull, "sorted" is assumed as the default.- Specified by:
getKindin interfaceFsIndexDescription- Returns:
- the kind of index
- See Also:
-
setKind
Description copied from interface:FsIndexDescriptionSets the "kind" of index. There are currently three kinds of indexes - sorted, set, and bag (seeFSIndexfor definitions). If this isnull, "sorted" is assumed as the default.- Specified by:
setKindin interfaceFsIndexDescription- Parameters:
aKind- the kind of index- See Also:
-
getKeys
Description copied from interface:FsIndexDescriptionGets the keys for this index. The keys determine the ordering of FeatureStructures in this index.- Specified by:
getKeysin interfaceFsIndexDescription- Returns:
- the keys for this index
- See Also:
-
setKeys
Description copied from interface:FsIndexDescriptionSets the keys for this index. The keys determine the ordering of FeatureStructures in this index.- Specified by:
setKeysin interfaceFsIndexDescription- Parameters:
aKeys- the keys for this index- 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
-