Interface IIndexClass
An IndexClass describes the index data that may be associated with a INode.
The IField objects returned from the methods of this class are read-only. All methods of these IField objects that are value-specific (for example IField.getValue()) will throw an Error.
Properties list
Methods list
Properties
description
Declaration
readonly description: string;
Property Value
| Type | Description |
|---|---|
| string |
name
Declaration
readonly name: string;
Property Value
| Type | Description |
|---|---|
| string |
Methods
getDescription()
The description of this IndexClass
Declaration
getDescription(): string;
Returns
| Type | Description |
|---|---|
| string |
getField(name)
Declaration
getField(name: string): IField;
Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
the name of the Index Field |
Returns
| Type | Description |
|---|---|
| IField | the IField object with that name. |
getFields()
A name-IField map
Declaration
getFields(): Map<string, IField>;
Returns
| Type | Description |
|---|---|
| Map<string, IField> |
getFieldsAsList()
The list of IField
Declaration
getFieldsAsList(): IField[];
Returns
| Type | Description |
|---|---|
| IField[] |
getName()
The name of this IndexClass
Declaration
getName(): string;
Returns
| Type | Description |
|---|---|
| string |