Package com.inductiveautomation.ignition.common

Class StreamingDatasetJsonWriter

java.lang.Object

com.inductiveautomation.ignition.common.StreamingDatasetJsonWriter

All Implemented Interfaces:

StreamingDatasetWriter

public class StreamingDatasetJsonWriter
extends java.lang.Object
implements StreamingDatasetWriter

Constructor Summary

Constructors

Constructor	Description
StreamingDatasetJsonWriter(com.inductiveautomation.ignition.common.gson.stream.JsonWriter writer, java.util.function.Consumer<java.lang.Exception> exceptionHandler)

Method Summary

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.
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	write(java.lang.Object[] data, QualityCode[] quality)	Writes a row with the given data.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingDatasetJsonWriter

public StreamingDatasetJsonWriter(com.inductiveautomation.ignition.common.gson.stream.JsonWriter writer,
                                  java.util.function.Consumer<java.lang.Exception> exceptionHandler)

Method Detail

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 interface StreamingDatasetWriter

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)
           throws java.io.IOException

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 interface StreamingDatasetWriter

Throws:

java.io.IOException

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 interface StreamingDatasetWriter

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 interface StreamingDatasetWriter