Package com.inductiveautomation.gateway.tags.history.module

Class TagHistoryProvider

java.lang.Object

com.inductiveautomation.gateway.tags.history.module.TagHistoryProvider

All Implemented Interfaces:

AnnotationQueryProvider, AnnotationStorageProvider, TagHistoryProvider, TagHistoryQueryInterface

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TagHistoryProvider.ProviderId	This class is how we adapt all the different ways (well, 3 or so ways) we've encoded this information throughout history.

Constructor Summary

Constructors

Constructor	Description
TagHistoryProvider(GatewayContext context, TagHistoryProviderRecord profile, TagHistorianSettingsRecord settings)

Method Summary

Modifier and Type	Method	Description
Results	browse(QualifiedPath root, BrowseFilter filter)
HistoryQueryExecutor	createQuery(java.util.List<ColumnQueryDefinition> cols, 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()
protected TagHistoryProvider.ProviderId	providerIdFrom(QualifiedPath qp, java.lang.String thisSysName)
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

Constructor Detail

TagHistoryProvider

public TagHistoryProvider(GatewayContext context,
                          TagHistoryProviderRecord profile,
                          TagHistorianSettingsRecord settings)

Method Detail

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

getStatus

public ProfileStatus getStatus()

Specified by:

getStatus in interface TagHistoryProvider

getStatusInformation

public TagHistoryProviderInformation getStatusInformation()

Specified by:

getStatusInformation 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

createQuery

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

Specified by:

createQuery in interface TagHistoryQueryInterface

browse

public Results 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

providerIdFrom

protected TagHistoryProvider.ProviderId providerIdFrom(QualifiedPath qp,
                                                       java.lang.String thisSysName)