com.inductiveautomation.gateway.tsdb.api

Class AbstractHistorian

java.lang.Object

com.inductiveautomation.gateway.tsdb.api.AbstractHistorian

All Implemented Interfaces:

Historian

public abstract class AbstractHistorian
extends java.lang.Object
implements Historian

Field Summary

Fields inherited from interface com.inductiveautomation.gateway.tsdb.api.Historian

QUALITY_NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
AbstractHistorian()

Method Summary

Modifier and Type	Method and Description
QueryResult	query(java.util.List<java.lang.String> tags, long startTime, long endTime, boolean includeBounding) Queries the values for the given paths over the specified span of time.
protected abstract void	query(java.util.List<java.lang.String> tags, long start, long end, ResultPublisher publisher) A protected version of query that is executed in a separate thread and given a result publisher.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.gateway.tsdb.api.Historian

browse, createStorageSession, delete, getProperty, getQueryStatus, getStorageStatus, initialize, register, shutdown

Constructor Detail

AbstractHistorian

public AbstractHistorian()

Method Detail

query

public QueryResult query(java.util.List<java.lang.String> tags,
                         long startTime,
                         long endTime,
                         boolean includeBounding)

Description copied from interface: Historian

Queries the values for the given paths over the specified span of time. The implementation will conform to the following rules:

1. If endTime is less than start time, results MAY be provided latest first. If that is not possible, the parameters will be swapped and values returned as normal.
2. The result will have a unique PathInfo item for EACH of the paths passed in. If a path is specified multiple times, it will be returned multiple times.
3. If a path is not valid, the query result will return ONE DataPoint for the query start time with a quality of 404 (NOT FOUND)
4. The timestamps for a given path will be ascending, though between paths they may not be.

Specified by:

query in interface Historian

includeBounding - if true, the closest value previous to the start time will be returned, as well as the closest value following the end time.

query

protected abstract void query(java.util.List<java.lang.String> tags,
                              long start,
                              long end,
                              ResultPublisher publisher)

A protected version of query that is executed in a separate thread and given a result publisher. The implementation can simply publish data points as long as the query isn't cancelled.