Package com.inductiveautomation.ignition.common

Interface SubIndex

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArrayIndex, DocumentIndex
public interface SubIndex extends 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 Details

    • isCompatible

      boolean isCompatible(Class<?> dataClazz)
      Returns whether this sub index can be used with the incoming value type.

    • extractValue

      QualifiedValue extractValue(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(Object sourceValue, Object elementValue)

    • toEncodedString

      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.