Class RemoteHistorianProvider
- java.lang.Object
-
- com.inductiveautomation.gateway.tags.history.distributed.client.RemoteHistorianProvider
-
- All Implemented Interfaces:
AnnotationQueryProvider
,TagHistoryProvider
,TagHistoryQueryInterface
public class RemoteHistorianProvider extends java.lang.Object implements TagHistoryProvider
-
-
Field Summary
Fields Modifier and Type Field Description protected LoggerEx
logger
protected static ProfileStatus
RUNNING_READONLY
protected static ProfileStatus
SINK_FAULTED
-
Constructor Summary
Constructors Constructor Description RemoteHistorianProvider(GatewayContext context, java.lang.String name, RemoteHistorianSettings settings)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Results
browse(QualifiedPath root, BrowseFilter filter)
HistoryQueryExecutor
createQuery(java.util.List<ColumnQueryDefinition> columns, QueryController queryController)
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 TagHistoryService
provider()
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()
protected QualifiedPath
transformPath(QualifiedPath path, boolean fromRemote)
protected QualifiedPath
transformPathFromRemote(QualifiedPath path)
protected QualifiedPath
transformPathToRemote(QualifiedPath path)
Replaces "histProvider" elements with remote provider nameprotected java.util.Collection<Result>
transformResultsFromRemote(java.util.Collection<Result> results)
-
-
-
Field Detail
-
RUNNING_READONLY
protected static final ProfileStatus RUNNING_READONLY
-
SINK_FAULTED
protected static final ProfileStatus SINK_FAULTED
-
logger
protected LoggerEx logger
-
-
Constructor Detail
-
RemoteHistorianProvider
public RemoteHistorianProvider(GatewayContext context, java.lang.String name, RemoteHistorianSettings settings)
-
-
Method Detail
-
getStatusInformation
public TagHistoryProviderInformation getStatusInformation()
- Specified by:
getStatusInformation
in interfaceTagHistoryProvider
-
provider
protected TagHistoryService provider()
-
browse
public Results browse(QualifiedPath root, BrowseFilter filter)
- Specified by:
browse
in interfaceTagHistoryProvider
-
transformResultsFromRemote
protected java.util.Collection<Result> transformResultsFromRemote(java.util.Collection<Result> results)
-
transformPathFromRemote
protected QualifiedPath transformPathFromRemote(QualifiedPath path)
-
transformPathToRemote
protected QualifiedPath transformPathToRemote(QualifiedPath path)
Replaces "histProvider" elements with remote provider name
-
transformPath
protected QualifiedPath transformPath(QualifiedPath path, boolean fromRemote)
-
createQuery
public HistoryQueryExecutor createQuery(java.util.List<ColumnQueryDefinition> columns, QueryController queryController)
- Specified by:
createQuery
in interfaceTagHistoryQueryInterface
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceTagHistoryProvider
-
getStatus
public ProfileStatus getStatus()
- Specified by:
getStatus
in interfaceTagHistoryProvider
-
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 interfaceTagHistoryQueryInterface
-
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 interfaceTagHistoryQueryInterface
- 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 interfaceAnnotationQueryProvider
- Throws:
java.lang.Exception
-
startup
public void startup()
- Specified by:
startup
in interfaceTagHistoryProvider
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfaceTagHistoryProvider
-
-