Package com.inductiveautomation.historian.gateway

Class HistorianManagerImpl

java.lang.Object

com.inductiveautomation.historian.gateway.HistorianManagerImpl

All Implemented Interfaces:

HistorianManager, ExtensionPointManager<com.inductiveautomation.historian.gateway.api.HistorianExtensionPoint<?>>, TagHistoryManager, ModuleService

public class HistorianManagerImpl
extends Object
implements TagHistoryManager, HistorianManager, ExtensionPointManager<com.inductiveautomation.historian.gateway.api.HistorianExtensionPoint<?>>

Constructor Summary

Constructors

Constructor	Description
HistorianManagerImpl()

Method Summary

Modifier and Type	Method	Description
QualityCode	applyAnnotationChanges(List<AnnotationChangePoint> annotationChangePoints, boolean blockForResult)
QualityCode	applySourceChanges(List<SourceChangePoint> sourceChangePoints, boolean blockForResult)
protected Results<Result>	browseHistoricalProviders()
Results<Result>	browseHistoricalTags(QualifiedPath root, BrowseFilter filter)
ExtensionPointCollection<com.inductiveautomation.historian.gateway.api.HistorianExtensionPoint<?>>	getExtensionPointCollection()
ResourceType	getExtensionPointResourceType()
Collection<String>	getHistorianNames()	Retrieves a collection of historian names available in the system.
Optional<QueryEngine>	getQueryEngine(String historianName)	Retrieves the QueryEngine associated with the specified historian name, if available.
TagHistoryQueryInterface	getQueryInterface(String provider)
ProfileStatus	getStatus(String provider)
Optional<StorageEngine>	getStorageEngine(String historianName)	Retrieves the StorageEngine associated with the specified historian name, if available.
List<String>	getTagHistoryProviders()
boolean	isLicensedForStorage()	Returns whether this gateway is licensed for storage.
Results<AnnotationPoint>	queryAnnotations(AnnotationQueryOptions queryOptions)
List<Annotation>	queryAnnotations(List<? extends Path> paths, Date start, Date end, TypeFilter filter)
void	queryDataPoints(DataPointQueryOptions<?> queryOptions, ResultWriterOptions writerOptions, StreamingDatasetWriter datasetWriter)
void	queryHistory(TagHistoryQueryParams query, StreamingDatasetWriter writer)	Queries the tag history system for the data as defined by the query parameters.
void	queryHistoryDensity(StreamingDatasetWriter writer, List<? extends Path> paths, Date start, Date end)	Queries the tag store for data density information.
TimelineSet	queryHistoryDensity(List<QualifiedPath> qpaths, Date start, Date end)
Results<MetadataPoint>	queryMetadata(MetadataQueryOptions queryOptions)
void	setup(GatewayContext context)
void	shutdown()
void	startup()
QualityCode	storeAnnotationPoints(List<AnnotationPoint> annotationPoints, boolean blockForResult)
List<QualifiedValue>	storeAnnotations(List<Annotation> annotations)	Stores the given annotations.
QualityCode	storeAtomicPoints(List<AtomicPoint<?>> atomicPoints, boolean blockForResult)
void	storeLegacyHistoryData(String historianName, List<TagHistoryData> tagHistoryData)
QualityCode	storeMetadataPoints(List<MetadataPoint> metadataPoints, boolean blockForResult)

Methods inherited from class java.lang.Object

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

Constructor Details

HistorianManagerImpl

public HistorianManagerImpl()

Method Details

setup

public void setup(GatewayContext context)
           throws Exception

Throws:

Exception

isLicensedForStorage

public boolean isLicensedForStorage()

Description copied from interface: TagHistoryManager

Returns whether this gateway is licensed for storage.

Specified by:

isLicensedForStorage in interface TagHistoryManager

Returns:

true if data can be stored.

startup

public void startup()

shutdown

public void shutdown()

getExtensionPointResourceType

public ResourceType getExtensionPointResourceType()

Specified by:

getExtensionPointResourceType in interface ExtensionPointManager<com.inductiveautomation.historian.gateway.api.HistorianExtensionPoint<?>>

getExtensionPointCollection

public ExtensionPointCollection<com.inductiveautomation.historian.gateway.api.HistorianExtensionPoint<?>> getExtensionPointCollection()

Specified by:

getExtensionPointCollection in interface ExtensionPointManager<com.inductiveautomation.historian.gateway.api.HistorianExtensionPoint<?>>

queryMetadata

public Results<MetadataPoint> queryMetadata(MetadataQueryOptions queryOptions)

queryDataPoints

public void queryDataPoints(DataPointQueryOptions<?> queryOptions,
 ResultWriterOptions writerOptions,
 StreamingDatasetWriter datasetWriter)

storeAtomicPoints

public QualityCode storeAtomicPoints(List<AtomicPoint<?>> atomicPoints,
 boolean blockForResult)

storeMetadataPoints

public QualityCode storeMetadataPoints(List<MetadataPoint> metadataPoints,
 boolean blockForResult)

storeAnnotationPoints

public QualityCode storeAnnotationPoints(List<AnnotationPoint> annotationPoints,
 boolean blockForResult)

applySourceChanges

public QualityCode applySourceChanges(List<SourceChangePoint> sourceChangePoints,
 boolean blockForResult)

applyAnnotationChanges

public QualityCode applyAnnotationChanges(List<AnnotationChangePoint> annotationChangePoints,
 boolean blockForResult)

getStatus

public ProfileStatus getStatus(String provider)

Specified by:

getStatus in interface TagHistoryManager

getQueryInterface

public TagHistoryQueryInterface getQueryInterface(String provider)

Specified by:

getQueryInterface in interface TagHistoryManager

queryHistory

public void queryHistory(TagHistoryQueryParams query,
 StreamingDatasetWriter writer)

Description copied from interface: TagHistoryManager

Queries the tag history system for the data as defined by the query parameters. The results are written to the provided StreamingDatasetWriter. This allows results to be streamed and not collected in memory. However, in order to get a simple Dataset result, simply use the BasicStreamingDataset.

Specified by:

queryHistory in interface TagHistoryManager

queryHistoryDensity

public void queryHistoryDensity(StreamingDatasetWriter writer,
 List<? extends Path> paths,
 Date start,
 Date end)
                         throws Exception

Description copied from interface: TagHistoryManager

Queries the tag store for data density information. Will return a structure with two columns: a timestamp, and the "weight", which is not really defined, but instead relative across the return set. The weight is valid until the next entry.

Specified by:

queryHistoryDensity in interface TagHistoryManager

Throws:

Exception

queryHistoryDensity

public TimelineSet queryHistoryDensity(List<QualifiedPath> qpaths,
 Date start,
 Date end)
                                throws Exception

Specified by:

queryHistoryDensity in interface TagHistoryManager

Throws:

Exception

queryAnnotations

public Results<AnnotationPoint> queryAnnotations(AnnotationQueryOptions queryOptions)

queryAnnotations

public List<Annotation> queryAnnotations(List<? extends Path> paths,
 Date start,
 Date end,
 TypeFilter filter)

Specified by:

queryAnnotations in interface TagHistoryManager

storeAnnotations

public List<QualifiedValue> storeAnnotations(List<Annotation> annotations)

Description copied from interface: TagHistoryManager

Stores the given annotations. Returns the new id of the stored annotation, if the quality code is good.

Specified by:

storeAnnotations in interface TagHistoryManager

Returns:

a 1-to-1 result for each annotation, with the result quality, and the new storage id if successful.

browseHistoricalTags

public Results<Result> browseHistoricalTags(QualifiedPath root,
 @Nullable
 BrowseFilter filter)
                                     throws InvalidQualifiedPathException

Specified by:

browseHistoricalTags in interface TagHistoryManager

Throws:

InvalidQualifiedPathException

browseHistoricalProviders

protected Results<Result> browseHistoricalProviders()

getStorageEngine

public Optional<StorageEngine> getStorageEngine(String historianName)

Description copied from interface: HistorianManager

Retrieves the StorageEngine associated with the specified historian name, if available. The StorageEngine serves as the interface for managing data storage and retrieval operations for the given historian.

Specified by:

getStorageEngine in interface HistorianManager

Parameters:

historianName - the name of the historian for which the storage engine is to be retrieved; must not be null

Returns:

an Optional containing the StorageEngine if one is available for the specified historian, or an empty Optional otherwise

getQueryEngine

public Optional<QueryEngine> getQueryEngine(String historianName)

Description copied from interface: HistorianManager

Retrieves the QueryEngine associated with the specified historian name, if available. The QueryEngine provides methods for querying historical data managed by the specified historian.

Specified by:

getQueryEngine in interface HistorianManager

Parameters:

historianName - the name of the historian for which the query engine is to be retrieved; must not be null

Returns:

an Optional containing the QueryEngine if one is available for the specified historian, or an empty Optional otherwise

getHistorianNames

public Collection<String> getHistorianNames()

Description copied from interface: HistorianManager

Retrieves a collection of historian names available in the system.

Specified by:

getHistorianNames in interface HistorianManager

Returns:

a Collection of String representing the names of available historians

getTagHistoryProviders

public List<String> getTagHistoryProviders()

Specified by:

getTagHistoryProviders in interface TagHistoryManager

storeLegacyHistoryData

public void storeLegacyHistoryData(String historianName,
 List<TagHistoryData> tagHistoryData)
                            throws Exception

Throws:

Exception