Package com.inductiveautomation.ignition.gateway.historian

Class AssociatedHistoryQueryInterface

java.lang.Object

com.inductiveautomation.ignition.gateway.historian.AssociatedHistoryQueryInterface

All Implemented Interfaces:

TagHistoryQueryInterface

public class AssociatedHistoryQueryInterface
extends Object
implements TagHistoryQueryInterface

This class provides a TagHistoryQueryInterface for an associated historical provider. This means we know the provider's name, and a way to transform paths to it, and then we can query through it as necessary.

Constructor Summary

Constructors

Constructor	Description
AssociatedHistoryQueryInterface(GatewayContext context, String historyProvider, QualifiedPathTransform transform)

Method Summary

Modifier and Type	Method	Description
Results<? extends Result>	browse(QualifiedPath root, BrowseFilter filter)
HistoryQueryExecutor	createQuery(List<ColumnQueryDefinition> paths, QueryController controller)
protected Optional<TagHistoryQueryInterface>	get()
List<Aggregate>	getAvailableAggregates()	Returns a list of aggregate functions that can be used with the server.
List<Annotation>	queryAnnotations(List<QualifiedPath> paths, Date start, Date end, TypeFilter filter, String queryId)
TimelineSet	queryDensity(List<QualifiedPath> paths, Date start, Date end, String queryId)

Methods inherited from class java.lang.Object

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

Constructor Details

AssociatedHistoryQueryInterface

public AssociatedHistoryQueryInterface(GatewayContext context,
 String historyProvider,
 QualifiedPathTransform transform)

Method Details

get

protected Optional<TagHistoryQueryInterface> get()

getAvailableAggregates

public List<Aggregate> getAvailableAggregates()

Description copied from interface: TagHistoryQueryInterface

Returns a list of aggregate functions that can be used with the server. Only expected to be valid if the server is enabled and available. Also, should only return null if the aggregates can not be retrieved for some reason. If the server simply does not support any aggregate functions, an empty list should be returned.

Specified by:

getAvailableAggregates in interface TagHistoryQueryInterface

browse

public Results<? extends Result> browse(QualifiedPath root,
 BrowseFilter filter)

Specified by:

browse in interface TagHistoryQueryInterface

queryAnnotations

public List<Annotation> queryAnnotations(List<QualifiedPath> paths,
 Date start,
 Date end,
 TypeFilter filter,
 String queryId)
                                  throws Exception

Specified by:

queryAnnotations in interface TagHistoryQueryInterface

Throws:

Exception

createQuery

public HistoryQueryExecutor createQuery(List<ColumnQueryDefinition> paths,
 QueryController controller)

Specified by:

createQuery in interface TagHistoryQueryInterface

queryDensity

public TimelineSet queryDensity(List<QualifiedPath> paths,
 Date start,
 Date end,
 String queryId)
                         throws Exception

Specified by:

queryDensity in interface TagHistoryQueryInterface

Throws:

Exception