|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FsIndexDescription
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 |
---|
static final java.lang.String KIND_SORTED
FSIndex
,
Constant Field Valuesstatic final java.lang.String KIND_SET
FSIndex
,
Constant Field Valuesstatic final java.lang.String KIND_BAG
FSIndex
,
Constant Field ValuesMethod Detail |
---|
java.lang.String getLabel()
void setLabel(java.lang.String aLabel)
aLabel
- the label of this index.java.lang.String getTypeName()
void setTypeName(java.lang.String aTypeName)
aTypeName
- the type name for this indexjava.lang.String getKind()
FSIndex
for definitions). If this is null
,
"sorted" is assumed as the default.
void setKind(java.lang.String aKind)
FSIndex
for definitions). If this is null
,
"sorted" is assumed as the default.
aKind
- the kind of indexFsIndexKeyDescription[] getKeys()
void setKeys(FsIndexKeyDescription[] aKeys)
aKeys
- the keys for this index
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |