Class BasicStreamingDataset
- java.lang.Object
-
- com.inductiveautomation.ignition.common.AbstractDataset
-
- com.inductiveautomation.ignition.gateway.datasource.BasicStreamingDataset
-
- All Implemented Interfaces:
Dataset
,StreamingDatasetWriter
,java.io.Serializable
public class BasicStreamingDataset extends AbstractDataset implements StreamingDatasetWriter
Basic implementation of StreamingDatasetWriter that simply writes each row into an in-memory datastructure ( a List )- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.inductiveautomation.ignition.common.AbstractDataset
_columnNamesLowercase, columnNames, columnTypes, qualityCodes
-
-
Constructor Summary
Constructors Constructor Description BasicStreamingDataset()
BasicStreamingDataset(java.sql.ResultSet rs)
Creates a dataset by streaming the results of a JDBC ResultSetBasicStreamingDataset(java.util.List<java.lang.String> columnNames, java.util.List<java.lang.Class<?>> columnTypes)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
finish()
Notifies the writer to close- all data has been written.void
finishWithError(java.lang.Exception e)
Finishes the stream while indicating an error occurred.QualityCode[][]
getBulkQualityCodes()
java.lang.Exception
getError()
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 datasetjava.lang.Object
getValueAt(int row, int col)
Returns the value in the dataset at the given location.void
initialize(java.lang.String[] columnNames, java.lang.Class<?>[] columnTypes, boolean supportsQuality, int expectedRows)
Initializes the streaming dataset with important information, primarily the column names and types.void
printToConsole()
void
write(java.lang.Object[] data, QualityCode[] quality)
Writes a row with the given data.-
Methods inherited from class com.inductiveautomation.ignition.common.AbstractDataset
getAsXML, getColumnCount, getColumnIndex, getColumnName, getColumnNames, getColumnType, getColumnTypes, getPrimitiveValueAt, getValueAt, setColumnNames, setColumnTypes, 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
-
-
-
-
Constructor Detail
-
BasicStreamingDataset
public BasicStreamingDataset()
-
BasicStreamingDataset
public BasicStreamingDataset(java.util.List<java.lang.String> columnNames, java.util.List<java.lang.Class<?>> columnTypes)
-
BasicStreamingDataset
public BasicStreamingDataset(java.sql.ResultSet rs) throws java.sql.SQLException
Creates a dataset by streaming the results of a JDBC ResultSet- Throws:
java.sql.SQLException
-
-
Method Detail
-
getError
public java.lang.Exception getError()
-
initialize
public void initialize(java.lang.String[] columnNames, java.lang.Class<?>[] columnTypes, boolean supportsQuality, int expectedRows)
Description copied from interface:StreamingDatasetWriter
Initializes the streaming dataset with important information, primarily the column names and types. If supportsQuality is true, it is expected that every value added has an associated quality. expectedRows gives an idea as to how many rows will be returned- useful for progress indication. Should be -1 if the number cannot be known in advance.- Specified by:
initialize
in interfaceStreamingDatasetWriter
expectedRows
- -1 if not known, otherwise the number of rows that will be in the dataset.
-
write
public void write(java.lang.Object[] data, QualityCode[] quality)
Description copied from interface:StreamingDatasetWriter
Writes a row with the given data. Bounds and order of arrays must match that used to call initialize. quality may be null if dataset does not support quality.- Specified by:
write
in interfaceStreamingDatasetWriter
-
finish
public void finish()
Description copied from interface:StreamingDatasetWriter
Notifies the writer to close- all data has been written. Should be called from a finally block.- Specified by:
finish
in interfaceStreamingDatasetWriter
-
finishWithError
public void finishWithError(java.lang.Exception e)
Description copied from interface:StreamingDatasetWriter
Finishes the stream while indicating an error occurred. Either this, or the successful finish(), must be called.- Specified by:
finishWithError
in interfaceStreamingDatasetWriter
-
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
- Overrides:
getQualityAt
in classAbstractDataset
-
getRowCount
public int getRowCount()
Description copied from interface:Dataset
Return the number of rows in this dataset- Specified by:
getRowCount
in interfaceDataset
-
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 interfaceDataset
-
printToConsole
public void printToConsole()
-
getBulkQualityCodes
public QualityCode[][] getBulkQualityCodes()
- Overrides:
getBulkQualityCodes
in classAbstractDataset
-
-