Package com.inductiveautomation.ignition.common

Class ArrayIndex

java.lang.Object
com.inductiveautomation.ignition.common.ArrayIndex
All Implemented Interfaces:
SubIndex, Serializable
public class ArrayIndex extends Object implements SubIndex
A simple structure that holds an index into a single or double column array.
See Also:

  • Constructor Details

    • ArrayIndex

      public ArrayIndex(int row)

    • ArrayIndex

      public ArrayIndex(int row, int col)

  • Method Details

    • isArrayIndex

      public static boolean isArrayIndex(String value)

    • getRow

      public int getRow()

    • getCol

      public int getCol()

    • hasCol

      public boolean hasCol()

    • parse

      public static ArrayIndex parse(String value)
      A very simple parse mechanism. Allows: "[x]", "[x,y]", "x", "x,y"

    • getClass

      @Nullable public Class<?> getClass(Object object)
      Returns the class associated at the location for this ArrayIndex

    • isCompatible

      public boolean isCompatible(Class<?> dataClazz)
      Description copied from interface: SubIndex
      Returns whether this sub index can be used with the incoming value type.
      Specified by:
      isCompatible in interface SubIndex

    • extractValue

      public QualifiedValue extractValue(Object source)
      Description copied from interface: SubIndex
      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.
      Specified by:
      extractValue in interface SubIndex

    • updateValue

      public QualityCode updateValue(Object sourceValue, Object elementValue)
      Specified by:
      updateValue in interface SubIndex

    • toEncodedString

      public String toEncodedString()
      Description copied from interface: SubIndex
      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.
      Specified by:
      toEncodedString in interface SubIndex

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object