Class AbstractDataset
- java.lang.Object
-
- com.inductiveautomation.ignition.common.AbstractDataset
-
- All Implemented Interfaces:
Dataset
,java.io.Serializable
- Direct Known Subclasses:
BasicDataset
,BasicStreamingDataset
,ColumnFilteredDataSet
,OptimizedDataSet
public abstract class AbstractDataset extends java.lang.Object implements Dataset
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<java.lang.String>
_columnNamesLowercase
Transient variable to make case insensitive lookups quickprotected java.util.List<java.lang.String>
columnNames
protected java.util.List<java.lang.Class<?>>
columnTypes
protected QualityCode[][]
qualityCodes
-
Constructor Summary
Constructors Constructor Description AbstractDataset(java.util.List<java.lang.String> columnNames, java.util.List<java.lang.Class<?>> columnTypes)
AbstractDataset(java.util.List<java.lang.String> columnNames, java.util.List<java.lang.Class<?>> columnTypes, QualityCode[][] qualityCodes)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected static QualityCode[][]
convertToQualityCodes(DataQuality[][] dataQualities)
java.lang.String
getAsXML()
Deprecated.QualityCode[][]
getBulkQualityCodes()
int
getColumnCount()
Returns the number of columns.int
getColumnIndex(java.lang.String colName)
Returns the index of the given column, case insensitivejava.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.java.lang.Object
getValueAt(int row, java.lang.String colName)
Returns the value at the given row and at a column named colName.protected void
setColumnNames(java.util.List<java.lang.String> list)
protected void
setColumnTypes(java.util.List<java.lang.Class<?>> list)
protected void
setDirty()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.common.Dataset
binarySearch, getColumnAsList, getRowCount, getValueAt
-
-
-
-
Field Detail
-
columnNames
protected java.util.List<java.lang.String> columnNames
-
_columnNamesLowercase
protected java.util.List<java.lang.String> _columnNamesLowercase
Transient variable to make case insensitive lookups quick
-
columnTypes
protected java.util.List<java.lang.Class<?>> columnTypes
-
qualityCodes
protected QualityCode[][] qualityCodes
-
-
Constructor Detail
-
AbstractDataset
public AbstractDataset(java.util.List<java.lang.String> columnNames, java.util.List<java.lang.Class<?>> columnTypes)
-
AbstractDataset
public AbstractDataset(java.util.List<java.lang.String> columnNames, java.util.List<java.lang.Class<?>> columnTypes, QualityCode[][] qualityCodes)
-
-
Method Detail
-
getColumnIndex
public int getColumnIndex(java.lang.String colName)
Returns the index of the given column, case insensitive- Specified by:
getColumnIndex
in interfaceDataset
- Parameters:
colName
- the name of the column to look upw- Returns:
- the index of the column
- Throws:
java.lang.ArrayIndexOutOfBoundsException
- if the column doesn't exist
-
getColumnCount
public int getColumnCount()
Description copied from interface:Dataset
Returns the number of columns.- Specified by:
getColumnCount
in interfaceDataset
-
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 interfaceDataset
-
getColumnName
public java.lang.String getColumnName(int col)
Description copied from interface:Dataset
Returns the name of the given column.- Specified by:
getColumnName
in interfaceDataset
-
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 interfaceDataset
-
getColumnType
public java.lang.Class<?> getColumnType(int col)
Description copied from interface:Dataset
Returns the type of the given column.- Specified by:
getColumnType
in interfaceDataset
-
setColumnNames
protected void setColumnNames(java.util.List<java.lang.String> list)
-
setColumnTypes
protected void setColumnTypes(java.util.List<java.lang.Class<?>> list)
-
setDirty
protected void setDirty()
-
getPrimitiveValueAt
public 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. The Chart uses this functionality to provide a seamless interface with the optimized dataset.- Specified by:
getPrimitiveValueAt
in interfaceDataset
-
getValueAt
public java.lang.Object getValueAt(int row, java.lang.String colName)
Returns the value at the given row and at a column named colName. Column name matching is case insensitive.- Specified by:
getValueAt
in interfaceDataset
-
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 interfaceDataset
-
getBulkQualityCodes
public QualityCode[][] getBulkQualityCodes()
-
getAsXML
@Deprecated public java.lang.String getAsXML()
Deprecated.Returns the data of the dataset as a Base64-encoded zipped XML string
-
convertToQualityCodes
protected static QualityCode[][] convertToQualityCodes(DataQuality[][] dataQualities)
-
-