SubIndex

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ArrayIndex, DocumentIndex
```
public interface SubIndex
extends java.io.Serializable
```
A SubIndex represents a way to get a sub element from a value. Different implementations can do things like pull values from arrays, datasets, and documents.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`QualifiedValue`	`extractValue(java.lang.Object source)`	Pulls the value out of a qualified value.
`boolean`	`isCompatible(java.lang.Class<?> dataClazz)`	Returns whether this sub index can be used with the incoming value type.
`java.lang.String`	`toEncodedString()`	Returns the index in a way that can be appended to a path.
`QualityCode`	`updateValue(java.lang.Object sourceValue, java.lang.Object elementValue)`

- Method Detail
  - isCompatible
```
boolean isCompatible(java.lang.Class<?> dataClazz)
```
    Returns whether this sub index can be used with the incoming value type.
  - extractValue
```
QualifiedValue extractValue(java.lang.Object source)
```
    Pulls the value out of a qualified value. The resulting value will have the same timestamp and quality as the source, unless a new quality is generated as a result of trying to extract the. Returns any errors as quality on the value.
  - updateValue
```
QualityCode updateValue(java.lang.Object sourceValue,
                        java.lang.Object elementValue)
```
  - toEncodedString
```
java.lang.String toEncodedString()
```
    Returns the index in a way that can be appended to a path. Should return a value that can be read by a static parse function on the implementation.