com.inductiveautomation.gateway.tags.history.thsplitter

Class TagHistorySplitterProvider

java.lang.Object

com.inductiveautomation.gateway.tags.history.thsplitter.TagHistorySplitterProvider

All Implemented Interfaces:

TagHistoryProvider

public class TagHistorySplitterProvider
extends java.lang.Object
implements TagHistoryProvider

This is the main class for the tag history splitter. It implements the TagHistoryProvider interface, which handles querying, and also contains the data sink (which it registers with the store and forward system) to handle storage. To keep things clean, the data sink could be broken out into its own class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TagHistorySplitterProvider.InternalDataSink

Constructor Summary

Constructors

Constructor and Description
TagHistorySplitterProvider(GatewayContext context, java.lang.String name, SplitterSettings settings)

Method Summary

Modifier and Type	Method and Description
protected QualifiedPath	adjustQPToConnection(QualifiedPath path, java.lang.String connection)
protected java.util.List<QualifiedPath>	adjustQualifiedPathsToConnection(java.util.List<QualifiedPath> paths, java.lang.String connection)
protected java.util.List<TagPath>	adjustTagPathsToConnection(java.util.List<TagPath> paths, java.lang.String connection) When we ultimately query, the tag paths must have the name of the connection we want.
BrowseResults<Result>	browse(QualifiedPath root, BrowseFilter filter)
HistoryQueryExecutor	createQuery(java.util.List<ColumnQueryDefinition> columnDefinitions, QueryController controller)
java.util.List<Aggregate>	getAvailableAggregates() Returns a list of aggregate functions that can be used with the server.
DataSink	getDataSink()
java.lang.String	getName()
protected TagHistoryProvider	getProvider(java.lang.String name)
ProfileStatus	getStatus()
TagHistoryProviderInformation	getStatusInformation()
boolean	isAvailable()
protected boolean	isAvailable(java.lang.String name)
TimelineSet	queryDensity(java.util.List<QualifiedPath> paths, java.util.Date start, java.util.Date end, java.lang.String queryId)
protected java.lang.String	selectConnection(java.util.Date start)
protected TagHistoryProvider	selectProvider(java.util.Date start)
void	shutdown()
void	startup()

Methods inherited from class java.lang.Object

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

Constructor Detail

TagHistorySplitterProvider

public TagHistorySplitterProvider(GatewayContext context,
                                  java.lang.String name,
                                  SplitterSettings settings)

Method Detail

getDataSink

public DataSink getDataSink()

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

getStatusInformation

public TagHistoryProviderInformation getStatusInformation()

Specified by:

getStatusInformation in interface TagHistoryProvider

isAvailable

public boolean isAvailable()

isAvailable

protected boolean isAvailable(java.lang.String name)

adjustTagPathsToConnection

protected java.util.List<TagPath> adjustTagPathsToConnection(java.util.List<TagPath> paths,
                                                             java.lang.String connection)

When we ultimately query, the tag paths must have the name of the connection we want. This changes the source from the current value (this provider) to the target connection.

Parameters:

paths -

Returns:

adjustQualifiedPathsToConnection

protected java.util.List<QualifiedPath> adjustQualifiedPathsToConnection(java.util.List<QualifiedPath> paths,
                                                                         java.lang.String connection)

adjustQPToConnection

protected QualifiedPath adjustQPToConnection(QualifiedPath path,
                                             java.lang.String connection)

getProvider

protected TagHistoryProvider getProvider(java.lang.String name)

selectProvider

protected TagHistoryProvider selectProvider(java.util.Date start)

selectConnection

protected java.lang.String selectConnection(java.util.Date start)

getStatus

public ProfileStatus getStatus()

Specified by:

getStatus in interface TagHistoryProvider

browse

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

Specified by:

browse in interface TagHistoryProvider

createQuery

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

Specified by:

createQuery in interface TagHistoryProvider

getAvailableAggregates

public java.util.List<Aggregate> getAvailableAggregates()

Description copied from interface: TagHistoryProvider

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 TagHistoryProvider

Returns:

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 TagHistoryProvider

Throws:

java.lang.Exception