com.inductiveautomation.gateway.tsdb.api

Interface QueryResult

All Superinterfaces:

java.util.Iterator<ResultDataPoint>

All Known Implementing Classes:

BasicQueryResult, FixedDailyDataHistorian.DataPump, NonStreamingQueryResults, SQLiteHistorian.Query

public interface QueryResult
extends java.util.Iterator<ResultDataPoint>

The results of a TSDB query. It is designed to provide values in a streaming fashion, either through a producer-consumer model with takeNext(), or an async consumer model by using onData(Consumer).
Important: Only one of the two models can be used at a time. Attempting to call takeNext after setting a data consumer, or viceversa, will result in an IllegalStateException.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the query.
java.util.List<PathInfo>	getPathInfo()
void	onData(java.util.function.Consumer<DataPoint> consumer, java.lang.Runnable onComplete)

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

getPathInfo

java.util.List<PathInfo> getPathInfo()

onData

void onData(java.util.function.Consumer<DataPoint> consumer,
            java.lang.Runnable onComplete)

cancel

void cancel()

Cancels the query. Will call onComplete immediately, and will no longer process values. If takeNext() is blocked, it will throw an interrupted exception.