org.apache.uima.resource.metadata
Interface FsIndexDescription

All Superinterfaces:
java.lang.Cloneable, MetaDataObject, java.io.Serializable, XMLizable
All Known Implementing Classes:
FsIndexDescription_impl

public interface FsIndexDescription
extends MetaDataObject

A description of a CAS feature structure index. This implements MetaDataObject, which implements XMLizable, so it can be serialized to and deserialized from an XML element.


Field Summary
static java.lang.String KIND_BAG
          Identifies a Bag index.
static java.lang.String KIND_SET
          Identifies a Set index.
static java.lang.String KIND_SORTED
          Identifies a Sorted index.
 
Method Summary
 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.
 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 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

KIND_SORTED

static final java.lang.String KIND_SORTED
Identifies a Sorted index.

See Also:
FSIndex, Constant Field Values

KIND_SET

static final java.lang.String KIND_SET
Identifies a Set index.

See Also:
FSIndex, Constant Field Values

KIND_BAG

static final java.lang.String KIND_BAG
Identifies a Bag index.

See Also:
FSIndex, Constant Field Values
Method Detail

getLabel

java.lang.String getLabel()
Gets the label of this index. This is the identifier used to retrieve the index from the CAS's Index Repository.

Returns:
the label of this index.

setLabel

void setLabel(java.lang.String aLabel)
Sets the label of this index. This is the identifier used to retrieve the index from the CAS's Index Repository.

Parameters:
aLabel - the label of this index.

getTypeName

java.lang.String getTypeName()
Gets the Type name for this index. This determines what type of FeatureStructures are contained in the index.

Returns:
the type name for this index

setTypeName

void setTypeName(java.lang.String aTypeName)
Sets the Type name for this index. This determines what type of FeatureStructures are contained in the index.

Parameters:
aTypeName - the type name for this index

getKind

java.lang.String getKind()
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.

Returns:
the kind of index

setKind

void setKind(java.lang.String aKind)
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.

Parameters:
aKind - the kind of index

getKeys

FsIndexKeyDescription[] getKeys()
Gets the keys for this index. The keys determine the ordering of FeatureStructures in this index.

Returns:
the keys for this index

setKeys

void setKeys(FsIndexKeyDescription[] aKeys)
Sets the keys for this index. The keys determine the ordering of FeatureStructures in this index.

Parameters:
aKeys - the keys for this index


Copyright © 2013. All Rights Reserved.