Package com.inductiveautomation.ignition.gateway.sqltags.history

Interface TagHistoryManager

All Known Subinterfaces:

GatewayTagHistoryManager

All Known Implementing Classes:

ProjectDefaultTagManagerFacade

public interface TagHistoryManager

Method Summary

Modifier and Type	Method	Description
Results<Result>	browseHistoricalTags(QualifiedPath root, BrowseFilter filter)
java.util.List<java.lang.String>	getTagHistoryProviders()	Returns the names of all of the registered tag history providers.
java.util.List<Annotation>	queryAnnotations(java.util.List<? extends Path> path, java.util.Date start, java.util.Date end, TypeFilter filter)
void	queryHistory(TagHistoryQueryParams query, StreamingDatasetWriter writer)	Queries the tag history system for the data as defined by the query parameters.
void	queryHistoryDensity(StreamingDatasetWriter writer, java.util.List<? extends Path> path, java.util.Date start, java.util.Date end)	Queries the tag store for data density information.
java.util.List<QualifiedValue>	storeAnnotations(java.util.List<Annotation> annotations)	Stores the given annotations.

Method Detail

getTagHistoryProviders

java.util.List<java.lang.String> getTagHistoryProviders()

Returns the names of all of the registered tag history providers. The return list is immutable.

queryHistory

void queryHistory(TagHistoryQueryParams query,
                  StreamingDatasetWriter writer)

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.

queryHistoryDensity

void queryHistoryDensity(StreamingDatasetWriter writer,
                         java.util.List<? extends Path> path,
                         java.util.Date start,
                         java.util.Date end)
                  throws java.lang.Exception

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.

Throws:

java.lang.Exception

queryAnnotations

java.util.List<Annotation> queryAnnotations(java.util.List<? extends Path> path,
                                            java.util.Date start,
                                            java.util.Date end,
                                            TypeFilter filter)

storeAnnotations

java.util.List<QualifiedValue> storeAnnotations(java.util.List<Annotation> annotations)

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

Returns:

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

browseHistoricalTags

Results<Result> browseHistoricalTags(QualifiedPath root,
                                     BrowseFilter filter)