com.inductiveautomation.ignition.gateway.tags.model

Class ProjectDefaultTagManagerFacade

java.lang.Object

com.inductiveautomation.ignition.gateway.tags.model.ProjectDefaultTagManagerFacade

All Implemented Interfaces:

TagManager, TagHistoryManager

public abstract class ProjectDefaultTagManagerFacade
extends java.lang.Object
implements TagManager, TagHistoryManager

A tag manager that translates tag paths sources between the "default" source of empty string and the absolute name of a project's default tag provider

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.tags.model.TagManager

BROWSE_LOCAL_SYSTEM, DATA_SOURCE_OPC

Constructor Summary

Constructors

Constructor and Description
ProjectDefaultTagManagerFacade(GatewayContext context, LoggerEx logger)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter filter)
Results<Result>	browseHistoricalTags(QualifiedPath root, BrowseFilter filter)
java.util.concurrent.CompletableFuture<Results<BrowseElement>>	browseTagDataSourcesAsync(java.lang.String provider, BrowseElement root, BrowseFilter filter)
protected abstract java.lang.String	getDefaultDatabaseName()
protected abstract java.lang.String	getDefaultTagProvider()
java.util.concurrent.CompletableFuture<TagDiagnostics>	getDiagnosticsAsync(TagPath path)
java.util.concurrent.CompletableFuture<ConfigurationPropertyModel>	getTagConfigModelAsync(java.lang.String provider)
java.util.concurrent.CompletableFuture<ConfigurationPropertyModel>	getTagGroupConfigModelAsync(java.lang.String provider)
java.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>>	getTagGroupsAsync(java.lang.String provider)
java.util.List<java.lang.String>	getTagHistoryProviders() Returns the names of all of the registered tag history providers.
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>	importTagsAsync(TagPath basePath, java.lang.String importText, java.lang.String importType, CollisionPolicy collisionPolicy)
boolean	matches(java.lang.String defaultTagProvider, java.lang.String defaultDatabaseName)
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> paths, java.util.Date start, java.util.Date end) Queries the tag store for data density information.
java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>>	readAsync(java.util.List<TagPath> tagPaths, SecurityContext security)
void	setDefaultTagProvider(java.lang.String newProvider)
java.util.concurrent.CompletableFuture<java.lang.Void>	subscribeAsync(java.util.List<TagPath> paths, java.util.List<TagChangeListener> listeners)
java.util.concurrent.CompletableFuture<java.lang.Void>	unsubscribeAsync(java.util.List<TagPath> paths, java.util.List<TagChangeListener> listeners)
java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>	writeAsync(java.util.List<TagPath> tagPaths, java.util.List<java.lang.Object> values, SecurityContext security)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagManager

readAsync, reinitializeTags, subscribeAsync, unsubscribeAsync, writeAsync

Constructor Detail

ProjectDefaultTagManagerFacade

public ProjectDefaultTagManagerFacade(GatewayContext context,
                                      LoggerEx logger)

Method Detail

matches

public boolean matches(java.lang.String defaultTagProvider,
                       java.lang.String defaultDatabaseName)

getDefaultTagProvider

@Nullable
protected abstract java.lang.String getDefaultTagProvider()

getDefaultDatabaseName

@Nullable
protected abstract java.lang.String getDefaultDatabaseName()

browseTagDataSourcesAsync

public java.util.concurrent.CompletableFuture<Results<BrowseElement>> browseTagDataSourcesAsync(java.lang.String provider,
                                                                                                BrowseElement root,
                                                                                                BrowseFilter filter)

Specified by:

browseTagDataSourcesAsync in interface TagManager

subscribeAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> subscribeAsync(java.util.List<TagPath> paths,
                                                                             java.util.List<TagChangeListener> listeners)

Specified by:

subscribeAsync in interface TagManager

unsubscribeAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> unsubscribeAsync(java.util.List<TagPath> paths,
                                                                               java.util.List<TagChangeListener> listeners)

Specified by:

unsubscribeAsync in interface TagManager

getTagGroupConfigModelAsync

public java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagGroupConfigModelAsync(java.lang.String provider)

Specified by:

getTagGroupConfigModelAsync in interface TagManager

getTagConfigModelAsync

public java.util.concurrent.CompletableFuture<ConfigurationPropertyModel> getTagConfigModelAsync(java.lang.String provider)

Specified by:

getTagConfigModelAsync in interface TagManager

getTagGroupsAsync

public java.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>> getTagGroupsAsync(java.lang.String provider)

Specified by:

getTagGroupsAsync in interface TagManager

browseAsync

public java.util.concurrent.CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath,
                                                                                    BrowseFilter filter)

Specified by:

browseAsync in interface TagManager

readAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualifiedValue>> readAsync(java.util.List<TagPath> tagPaths,
                                                                                        SecurityContext security)

Specified by:

readAsync in interface TagManager

writeAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> writeAsync(java.util.List<TagPath> tagPaths,
                                                                                      java.util.List<java.lang.Object> values,
                                                                                      SecurityContext security)

Specified by:

writeAsync in interface TagManager

getDiagnosticsAsync

public java.util.concurrent.CompletableFuture<TagDiagnostics> getDiagnosticsAsync(TagPath path)

Specified by:

getDiagnosticsAsync in interface TagManager

importTagsAsync

public java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> importTagsAsync(TagPath basePath,
                                                                                           java.lang.String importText,
                                                                                           java.lang.String importType,
                                                                                           CollisionPolicy collisionPolicy)

Specified by:

importTagsAsync in interface TagManager

Parameters:

basePath - tags will be imported using this location as the base. The provider source must be set.

importText - a String holding the contents of the file to import

importType - The import file type. Use "json", "xml" or "csv". Any other value will return an error.

collisionPolicy - The collision policy to use. Abort will throw an exception on the first tag collision, Ignore will not change the existing tag at all, Overwrite will overwrite the existing tag completely, and Rename will create a new tag with a similar name (MyTag becomes MyTag1).

setDefaultTagProvider

public void setDefaultTagProvider(java.lang.String newProvider)

browseHistoricalTags

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

Specified by:

browseHistoricalTags in interface TagHistoryManager

getTagHistoryProviders

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

Description copied from interface: TagHistoryManager

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

Specified by:

getTagHistoryProviders 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,
                                java.util.List<? extends Path> paths,
                                java.util.Date start,
                                java.util.Date end)
                         throws java.lang.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:

java.lang.Exception