Package com.inductiveautomation.ignition.common

Class ArrayIndex

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

    • Constructor Summary

      Constructors 
      Constructor Description
      ArrayIndex​(int row)  
      ArrayIndex​(int row, int col)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      QualifiedValue extractValue​(java.lang.Object source)
      Pulls the value out of a qualified value.
      java.lang.Class<?> getClass​(java.lang.Object object)
      Returns the class associated at the location for this ArrayIndex
      int getCol()  
      int getRow()  
      boolean hasCol()  
      int hashCode()  
      static boolean isArrayIndex​(java.lang.String value)  
      boolean isCompatible​(java.lang.Class<?> dataClazz)
      Returns whether this sub index can be used with the incoming value type.
      static ArrayIndex parse​(java.lang.String value)
      A very simple parse mechanism.
      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)  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ArrayIndex

        public ArrayIndex​(int row)

      • ArrayIndex

        public ArrayIndex​(int row,
                  int col)

    • Method Detail

      • isArrayIndex

        public static boolean isArrayIndex​(java.lang.String value)

      • getRow

        public int getRow()

      • getCol

        public int getCol()

      • hasCol

        public boolean hasCol()

      • parse

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

      • getClass

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

      • isCompatible

        public boolean isCompatible​(java.lang.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​(java.lang.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​(java.lang.Object sourceValue,
                               java.lang.Object elementValue)
        Specified by:
        updateValue in interface SubIndex

      • toEncodedString

        public java.lang.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​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object