org.apache.uima.resource.metadata.impl

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

Field Summary

Fields inherited from interface org.apache.uima.resource.metadata.FsIndexDescription

KIND_BAG, KIND_SET, KIND_SORTED

Constructor Summary

Constructors

Constructor and Description
FsIndexDescription_impl()

Method Summary

Methods

Modifier and Type	Method and 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, getAttributeClass, getAttributeValue, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, setAttributeValue, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, 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

Constructor Detail

FsIndexDescription_impl

public FsIndexDescription_impl()

Method Detail

getXMLElementTagName

protected java.lang.String getXMLElementTagName()

See Also:

org.apache.uima.resource.impl.MetaDataObject_impl#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 interface FsIndexDescription

Returns:

the label of this index.

See Also:

org.apache.uima.cas.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 interface FsIndexDescription

Parameters:

aLabel - the label of this index.

See Also:

org.apache.uima.cas.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 interface FsIndexDescription

Returns:

the type name for this index

See Also:

org.apache.uima.cas.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 interface FsIndexDescription

Parameters:

aTypeName - the type name for this index

See Also:

org.apache.uima.cas.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" (see FSIndex for definitions). If this is null, "sorted" is assumed as the default.

Specified by:

getKind in interface FsIndexDescription

Returns:

the kind of index

See Also:

org.apache.uima.cas.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 (see FSIndex for definitions). If this is null, "sorted" is assumed as the default.

Specified by:

setKind in interface FsIndexDescription

Parameters:

aKind - the kind of index

See Also:

org.apache.uima.cas.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 interface FsIndexDescription

Returns:

the keys for this index

See Also:

org.apache.uima.cas.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 interface FsIndexDescription

Parameters:

aKeys - the keys for this index

See Also:

org.apache.uima.cas.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 class MetaDataObject_impl

Returns:

information defining this object's XML representation