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:
java.io.Serializable
,java.lang.Cloneable
,FsIndexDescription
,MetaDataObject
,XMLizable
public class FsIndexDescription_impl extends MetaDataObject_impl implements FsIndexDescription
- 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 inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext
-
Fields inherited from interface org.apache.uima.resource.metadata.FsIndexDescription
EMPTY_FS_INDEX_DESCRIPTIONS, KIND_BAG, KIND_SET, KIND_SORTED
-
-
Constructor Summary
Constructors Constructor Description FsIndexDescription_impl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FsIndexKeyDescription[]
getKeys()
Gets the keys for this index.java.lang.String
getKind()
Gets the "kind" of index.java.lang.String
getLabel()
Gets the label of this index.java.lang.String
getTypeName()
Gets the Type name for this index.protected java.lang.String
getXMLElementTagName()
protected XmlizationInfo
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML.void
setKeys(FsIndexKeyDescription[] aKeys)
Sets the keys for this index.void
setKind(java.lang.String aKind)
Sets the "kind" of index.void
setLabel(java.lang.String aLabel)
Sets the label of this index.void
setTypeName(java.lang.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, writePropertyAsElement
-
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
-
-
-
-
Method Detail
-
getXMLElementTagName
protected java.lang.String getXMLElementTagName()
-
getLabel
public java.lang.String getLabel()
Description copied from interface:FsIndexDescription
Gets the label of this index. This is the identifier used to retrieve the index from the CAS's Index Repository.- Specified by:
getLabel
in interfaceFsIndexDescription
- Returns:
- the label of this index.
- See Also:
FsIndexDescription.getLabel()
-
setLabel
public void setLabel(java.lang.String aLabel)
Description copied from interface:FsIndexDescription
Sets the label of this index. This is the identifier used to retrieve the index from the CAS's Index Repository.- Specified by:
setLabel
in interfaceFsIndexDescription
- Parameters:
aLabel
- the label of this index.- See Also:
FsIndexDescription.setLabel(String)
-
getTypeName
public java.lang.String getTypeName()
Description copied from interface:FsIndexDescription
Gets the Type name for this index. This determines what type of FeatureStructures are contained in the index.- Specified by:
getTypeName
in interfaceFsIndexDescription
- Returns:
- the type name for this index
- See Also:
FsIndexDescription.getTypeName()
-
setTypeName
public void setTypeName(java.lang.String aTypeName)
Description copied from interface:FsIndexDescription
Sets the Type name for this index. This determines what type of FeatureStructures are contained in the index.- Specified by:
setTypeName
in interfaceFsIndexDescription
- Parameters:
aTypeName
- the type name for this index- See Also:
FsIndexDescription.setTypeName(String)
-
getKind
public java.lang.String getKind()
Description copied from interface:FsIndexDescription
Gets the "kind" of index. There are currently three kinds of indexes - "sorted", "set", and "bag" (seeFSIndex
for definitions). If this isnull
, "sorted" is assumed as the default.- Specified by:
getKind
in interfaceFsIndexDescription
- Returns:
- the kind of index
- See Also:
FsIndexDescription.getKind()
-
setKind
public void setKind(java.lang.String aKind)
Description copied from interface:FsIndexDescription
Sets the "kind" of index. There are currently three kinds of indexes - sorted, set, and bag (seeFSIndex
for definitions). If this isnull
, "sorted" is assumed as the default.- Specified by:
setKind
in interfaceFsIndexDescription
- Parameters:
aKind
- the kind of index- See Also:
FsIndexDescription.setKind(String)
-
getKeys
public FsIndexKeyDescription[] getKeys()
Description copied from interface:FsIndexDescription
Gets the keys for this index. The keys determine the ordering of FeatureStructures in this index.- Specified by:
getKeys
in interfaceFsIndexDescription
- Returns:
- the keys for this index
- See Also:
FsIndexDescription.getKeys()
-
setKeys
public void setKeys(FsIndexKeyDescription[] aKeys)
Description copied from interface:FsIndexDescription
Sets the keys for this index. The keys determine the ordering of FeatureStructures in this index.- Specified by:
setKeys
in interfaceFsIndexDescription
- Parameters:
aKeys
- the keys for this index- See Also:
FsIndexDescription.setKeys(FsIndexKeyDescription[])
-
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
-
-