Package com.inductiveautomation.ignition.common.script.builtin

Class DatasetUtilities.PyDataSet

    • Constructor Summary

      Constructors 
      Constructor Description
      PyDataSet()
      No arg constructor for serialization.
      PyDataSet​(Dataset ds)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object __getitem__​(int index)  
      java.lang.Object __getitem__​(org.python.core.PyObject index)  
      java.lang.Object __getslice__​(org.python.core.PyObject start, org.python.core.PyObject stop)  
      java.lang.Object __getslice__​(org.python.core.PyObject start, org.python.core.PyObject stop, org.python.core.PyObject step)  
      int __len__()  
      org.python.core.PyString __repr__()  
      int binarySearch​(int column, java.lang.Object key)
      Performs a binary search on the specified column, looking for the specified key.
      int getColumnCount()
      Returns the number of columns.
      int getColumnIndex​(java.lang.String name)
      Returns the index of the given column, case insensitive
      java.lang.String getColumnName​(int col)
      Returns the name of the given column.
      java.util.List<java.lang.String> getColumnNames()
      Returns an unmodifiable list of this dataset's column names, in order.
      java.lang.Class<?> getColumnType​(int col)
      Returns the type of the given column.
      java.util.List<java.lang.Class<?>> getColumnTypes()
      Returns an unmodifiable list of this dataset's column types, in order.
      double getPrimitiveValueAt​(int row, int col)
      If the given column is a numeric type or a Date, then the value will be returned as a double.
      QualityCode getQualityAt​(int row, int col)
      Returns the quality of the value at the given location.
      int getRowCount()
      Return the number of rows in this dataset
      Dataset getUnderlyingDataset()  
      java.lang.Object getValueAt​(int row, int col)
      Returns the value in the dataset at the given location.
      java.lang.Object getValueAt​(int row, java.lang.String colName)
      Returns the value at the given row and at a column named colName.
      void setData​(Dataset data)
      Used for serialization only.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PyDataSet

        public PyDataSet()
        No arg constructor for serialization.

      • PyDataSet

        public PyDataSet​(Dataset ds)

    • Method Detail

      • getUnderlyingDataset

        public Dataset getUnderlyingDataset()

      • __getitem__

        public java.lang.Object __getitem__​(int index)

      • __getitem__

        public java.lang.Object __getitem__​(org.python.core.PyObject index)

      • __getslice__

        public java.lang.Object __getslice__​(org.python.core.PyObject start,
                                     org.python.core.PyObject stop)

      • __getslice__

        public java.lang.Object __getslice__​(org.python.core.PyObject start,
                                     org.python.core.PyObject stop,
                                     org.python.core.PyObject step)

      • __len__

        public int __len__()

      • __repr__

        public org.python.core.PyString __repr__()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getColumnNames

        public java.util.List<java.lang.String> getColumnNames()
        Description copied from interface: Dataset
        Returns an unmodifiable list of this dataset's column names, in order.
        Specified by:
        getColumnNames in interface Dataset

      • getColumnTypes

        public java.util.List<java.lang.Class<?>> getColumnTypes()
        Description copied from interface: Dataset
        Returns an unmodifiable list of this dataset's column types, in order.
        Specified by:
        getColumnTypes in interface Dataset

      • getColumnCount

        public int getColumnCount()
        Description copied from interface: Dataset
        Returns the number of columns.
        Specified by:
        getColumnCount in interface Dataset

      • getRowCount

        public int getRowCount()
        Description copied from interface: Dataset
        Return the number of rows in this dataset
        Specified by:
        getRowCount in interface Dataset

      • getColumnIndex

        public int getColumnIndex​(java.lang.String name)
        Description copied from interface: Dataset
        Returns the index of the given column, case insensitive
        Specified by:
        getColumnIndex in interface Dataset
        Parameters:
        name - the name of the column to look up
        Returns:
        the index of the column

      • getColumnName

        public java.lang.String getColumnName​(int col)
        Description copied from interface: Dataset
        Returns the name of the given column.
        Specified by:
        getColumnName in interface Dataset

      • getColumnType

        public java.lang.Class<?> getColumnType​(int col)
        Description copied from interface: Dataset
        Returns the type of the given column.
        Specified by:
        getColumnType in interface Dataset

      • getValueAt

        public java.lang.Object getValueAt​(int row,
                                   int col)
        Description copied from interface: Dataset
        Returns the value in the dataset at the given location.
        Specified by:
        getValueAt in interface Dataset

      • getQualityAt

        public QualityCode getQualityAt​(int row,
                                int col)
        Description copied from interface: Dataset
        Returns the quality of the value at the given location.
        Specified by:
        getQualityAt in interface Dataset

      • getValueAt

        public java.lang.Object getValueAt​(int row,
                                   java.lang.String colName)
        Description copied from interface: Dataset
        Returns the value at the given row and at a column named colName. Column name matching is case insensitive.
        Specified by:
        getValueAt in interface Dataset

      • getPrimitiveValueAt

        public double getPrimitiveValueAt​(int row,
                                  int col)
        Description copied from interface: Dataset
        If the given column is a numeric type or a Date, then the value will be returned as a double. (Charts uses this functionality to provide a seamless interface with certain optimized dataset implementations.
        Specified by:
        getPrimitiveValueAt in interface Dataset

      • binarySearch

        public int binarySearch​(int column,
                        java.lang.Object key)
        Description copied from interface: Dataset
        Performs a binary search on the specified column, looking for the specified key. Column MUST be sorted in ascending order. Dataset provides an inefficient default implementation of binary search that allocates a new array list for the entire column.
        Specified by:
        binarySearch in interface Dataset
        Returns:
        index of the search key, if it is contained in the list; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the list: the index of the first element greater than the key, or list.size(), if all elements in the list are less than the specified key. Note that this guarantees the return value will be greater than or equal to 0, but only if the key is found.

      • setData

        public void setData​(Dataset data)
        Used for serialization only.
        Parameters:
        data - If null, creates an empty PyDataSet.