com.inductiveautomation.ignition.common.sqltags.history.cache

Class TimeMaskedDataset

java.lang.Object

com.inductiveautomation.ignition.common.sqltags.history.cache.TimeMaskedDataset

All Implemented Interfaces:

Dataset, java.io.Serializable

public class TimeMaskedDataset
extends java.lang.Object
implements Dataset

This dataset wrapper limits the view to a specific time range. It requires the first column of the result set to be a Date, unless the dateColumnPosition property is changed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeMaskedDataset(Dataset ds, long start, long end) Initializes the wrapper with the underlying data, and the time range.
TimeMaskedDataset(Dataset ds, long start, long end, int dateColumn)

Method Summary

Modifier and Type	Method and Description
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.
Dataset	getInternalDataset()
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.
DataQuality	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
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.
boolean	isDirectHit() Returns whether this "time masked" dataset covers the full range of the internal set.
void	setDateColumnPosition(int pos) Changes which column is the date column.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeMaskedDataset

public TimeMaskedDataset(Dataset ds,
                         long start,
                         long end)

Initializes the wrapper with the underlying data, and the time range. The range is inclusive. In other words, the last row's timestamp will potentially equal the end time.

TimeMaskedDataset

public TimeMaskedDataset(Dataset ds,
                         long start,
                         long end,
                         int dateColumn)

Method Detail

getInternalDataset

public Dataset getInternalDataset()

isDirectHit

public boolean isDirectHit()

Returns whether this "time masked" dataset covers the full range of the internal set.

setDateColumnPosition

public void setDateColumnPosition(int pos)

Changes which column is the date column. Default is 0.

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 upw

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 DataQuality 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.

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 that the return value will be >= 0 if and only if the key is found.