Package com.inductiveautomation.gateway.tags.history.tsdb

Class HistorianProvider

java.lang.Object

com.inductiveautomation.gateway.tags.history.tsdb.HistorianProvider

All Implemented Interfaces:

AnnotationQueryProvider, AnnotationStorageProvider, TagHistoryProvider, TagHistoryQueryInterface

Direct Known Subclasses:

InternalHistorianProvider

public class HistorianProvider
extends java.lang.Object
implements TagHistoryProvider, AnnotationStorageProvider, AnnotationQueryProvider

This is a generic TagHistoryProvider build around the tsdb Historian api. This essentially links our historian abstraction into the tag history system's store and query mechanisms. It can be used by provider types build around that system.

Field Summary

Fields

Modifier and Type	Field	Description
protected GatewayContext	context
protected Historian	historian
static Property<java.lang.String>	IMPLEMENTATION
protected LoggerEx	log
protected java.lang.String	name
protected DataSink	sink

Constructor Summary

Constructors

Constructor	Description
HistorianProvider(GatewayContext context, java.lang.String name)

Method Summary

Modifier and Type	Method	Description
Results<Result>	browse(QualifiedPath root, BrowseFilter filter)
protected void	buildBrowseCache()
protected LoggerEx	createLogger()
HistoryQueryExecutor	createQuery(java.util.List<ColumnQueryDefinition> paths, QueryController controller)
java.util.List<Aggregate>	getAvailableAggregates()	Returns a list of aggregate functions that can be used with the server.
java.lang.String	getName()
ProfileStatus	getStatus()
TagHistoryProviderInformation	getStatusInformation()
void	initialize(PropertySet properties)
protected DataSink	instantiateSink()
java.util.List<Annotation>	queryAnnotations(java.util.List<QualifiedPath> paths, java.util.Date start, java.util.Date end, TypeFilter filter, java.lang.String queryId)
TimelineSet	queryDensity(java.util.List<QualifiedPath> paths, java.util.Date start, java.util.Date end, java.lang.String queryId)
void	shutdown()
void	startup()
java.util.List<QualifiedValue>	storeAnnotations(java.util.List<Annotation> annotations)

Methods inherited from class java.lang.Object

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

Field Detail

IMPLEMENTATION

public static final Property<java.lang.String> IMPLEMENTATION

context

protected GatewayContext context

historian

protected Historian historian

name

protected java.lang.String name

log

protected LoggerEx log

sink

protected DataSink sink

Constructor Detail

HistorianProvider

public HistorianProvider(GatewayContext context,
                         java.lang.String name)

Method Detail

createLogger

protected LoggerEx createLogger()

initialize

public void initialize(PropertySet properties)
                throws java.lang.Exception

Throws:

java.lang.Exception

instantiateSink

protected DataSink instantiateSink()

startup

public void startup()

Specified by:

startup in interface TagHistoryProvider

shutdown

public void shutdown()

Specified by:

shutdown in interface TagHistoryProvider

getName

public java.lang.String getName()

Specified by:

getName in interface TagHistoryProvider

getAvailableAggregates

public java.util.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

getStatus

public ProfileStatus getStatus()

Specified by:

getStatus in interface TagHistoryProvider

createQuery

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

Specified by:

createQuery in interface TagHistoryQueryInterface

buildBrowseCache

protected void buildBrowseCache()

browse

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

Specified by:

browse in interface TagHistoryProvider

queryDensity

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

Specified by:

queryDensity in interface TagHistoryQueryInterface

Throws:

java.lang.Exception

queryAnnotations

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

Specified by:

queryAnnotations in interface AnnotationQueryProvider

Throws:

java.lang.Exception

storeAnnotations

public java.util.List<QualifiedValue> storeAnnotations(java.util.List<Annotation> annotations)

Specified by:

storeAnnotations in interface AnnotationStorageProvider

getStatusInformation

public TagHistoryProviderInformation getStatusInformation()

Specified by:

getStatusInformation in interface TagHistoryProvider