Class HistorianProvider
- java.lang.Object
-
- com.inductiveautomation.gateway.tags.history.tsdb.HistorianProvider
-
- All Implemented Interfaces:
TagHistoryProvider
- Direct Known Subclasses:
LocalHistorianProvider
public class HistorianProvider extends java.lang.Object implements TagHistoryProvider
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.
-
-
Constructor Summary
Constructors Constructor Description HistorianProvider(GatewayContext context, java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods 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()
TimelineSet
queryDensity(java.util.List<QualifiedPath> paths, java.util.Date start, java.util.Date end, java.lang.String queryId)
void
shutdown()
void
startup()
-
-
-
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 interfaceTagHistoryProvider
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfaceTagHistoryProvider
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceTagHistoryProvider
-
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 interfaceTagHistoryProvider
-
getStatus
public ProfileStatus getStatus()
- Specified by:
getStatus
in interfaceTagHistoryProvider
-
createQuery
public HistoryQueryExecutor createQuery(java.util.List<ColumnQueryDefinition> paths, QueryController controller)
- Specified by:
createQuery
in interfaceTagHistoryProvider
-
buildBrowseCache
protected void buildBrowseCache()
-
browse
public Results<Result> browse(QualifiedPath root, BrowseFilter filter)
- Specified by:
browse
in interfaceTagHistoryProvider
-
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 interfaceTagHistoryProvider
- Throws:
java.lang.Exception
-
getStatusInformation
public TagHistoryProviderInformation getStatusInformation()
- Specified by:
getStatusInformation
in interfaceTagHistoryProvider
-
-