public interface FsIndexDescription extends MetaDataObject
MetaDataObject,
which implements XMLizable, so it can be serialized to and
deserialized from an XML element.| Modifier and Type | Field and Description |
|---|---|
static FsIndexDescription[] |
EMPTY_FS_INDEX_DESCRIPTIONS |
static String |
KIND_BAG
Identifies a Bag index.
|
static String |
KIND_SET
Identifies a Set index.
|
static String |
KIND_SORTED
Identifies a Sorted index.
|
| Modifier and Type | Method and Description |
|---|---|
FsIndexKeyDescription[] |
getKeys()
Gets the keys for this index.
|
String |
getKind()
Gets the "kind" of index.
|
String |
getLabel()
Gets the label of this index.
|
String |
getTypeName()
Gets the Type name for this index.
|
void |
setKeys(FsIndexKeyDescription[] aKeys)
Sets the keys for this index.
|
void |
setKind(String aKind)
Sets the "kind" of index.
|
void |
setLabel(String aLabel)
Sets the label of this index.
|
void |
setTypeName(String aTypeName)
Sets the Type name for this index.
|
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlbuildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXMLstatic final FsIndexDescription[] EMPTY_FS_INDEX_DESCRIPTIONS
static final String KIND_SORTED
FSIndex,
Constant Field Valuesstatic final String KIND_SET
FSIndex,
Constant Field Valuesstatic final String KIND_BAG
FSIndex,
Constant Field ValuesString getLabel()
void setLabel(String aLabel)
aLabel - the label of this index.String getTypeName()
void setTypeName(String aTypeName)
aTypeName - the type name for this indexString getKind()
FSIndex for definitions). If this is null,
"sorted" is assumed as the default.void setKind(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 indexCopyright © 2006–2022 The Apache Software Foundation. All rights reserved.