DebugFSLogicalStructure.IndexInfo

java.lang.Object
- org.apache.uima.cas.impl.DebugFSLogicalStructure.IndexInfo

Enclosing class:

DebugFSLogicalStructure
```
public static class DebugFSLogicalStructure.IndexInfo
extends java.lang.Object
```
Class holding information about an FSIndex Includes the "label" of the index, and a ref to the CAS this index contents are in.

Field Summary

Fields
Modifier and Type Field Description

protected CAS cas

FSIndex<FeatureStructure> fsIndex

java.lang.String indexName

Constructor Summary

Constructors
Constructor Description

IndexInfo(CAS cas, java.lang.String indexName)

IndexInfo(CAS cas, java.lang.String indexName, Type type)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`getContents()`
`java.lang.Object`	`getKind()`
`java.lang.Object`	`getSubTypes()`
`java.lang.Object`	`getType()`
`java.lang.String`	`toString()`	Return a label identifying the content of the helper.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

indexName
```
public java.lang.String indexName
```

fsIndex

public FSIndex<FeatureStructure> fsIndex

cas
```
protected CAS cas
```

Constructor Detail
- IndexInfo
```
public IndexInfo(CAS cas,
                 java.lang.String indexName)
```
- IndexInfo
```
public IndexInfo(CAS cas,
                 java.lang.String indexName,
                 Type type)
```
  Parameters:
  
  cas - The CAS the index lives in.
  
  indexName - The name of the index to create the helper object for.
  
  type - The subtype to restrict the index to, null to use the index base type.

Method Detail

getKind
```
public java.lang.Object getKind()
```

getType
```
public java.lang.Object getType()
```

getContents
```
public java.lang.Object getContents()
```

getSubTypes
```
public java.lang.Object getSubTypes()
```

toString
```
public java.lang.String toString()
```
Return a label identifying the content of the helper.

Overrides:

toString in class java.lang.Object

Returns:

the label string.