com.inductiveautomation.ignition.gateway.sqltags.providers

Class ProviderSQLTagExecutor

java.lang.Object

com.inductiveautomation.ignition.gateway.sqltags.providers.ProviderSQLTagExecutor

All Implemented Interfaces:

TagCollection, TagManagerBase, TagSubscriptionManager, SQLTagsExecutor

public class ProviderSQLTagExecutor
extends java.lang.Object
implements SQLTagsExecutor, TagManagerBase

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.sqltags.model.TagManagerBase

TagManagerBase.CollisionPolicy

Constructor Summary

Constructors

Constructor and Description
ProviderSQLTagExecutor(GatewayContext context, AbstractStoreBasedTagProvider owner)

Method Summary

Modifier and Type	Method and Description
void	addTags(TagPath parentFolder, java.util.List<TagNode> tag, TagManagerBase.CollisionPolicy collisionPolicy) Adds the given tags into the parent folder.
java.util.List<Tag>	browse(TagPath root) Provides the tags located beneath the specified path.
void	editTags(java.util.List<TagPath> paths, TagDiff edit) Applies the given TagDiff edit to the paths indicated
java.lang.String	getDefaultDatasource()
java.lang.String	getDefaultTagSource() Returns the default tag source to be used when parsing tag reference paths.
java.lang.String	getDisplayNameForPath(TagPath path) Returns a friendly, fully qualified path for the given tag.
ExecutionManager	getExecutionManager()
GatewayContext	getGatewayContext()
java.lang.String	getName()
QualifiedPath	getObjectPath()
ScriptManager	getScriptManager() Returns the ScriptManager that can be used to execute Python scripts.
protected TagPath	getSourceFixedPath(TagPath path)
Tag	getTag(TagPath path) Returns the tag located at a specific path.
TagDiagnostics	getTagDiagnostics(TagPath path) Returns the current diagnostic information for a given path.
org.apache.log4j.Logger	getTagErrorLogger()
TagManagerBase	getTagManager() Returns a tagmanagerbase that can be used to look up tag references.
TagSubscriptionManager	getTagReferenceManager()
TagScriptManager	getTagScriptManager()
java.util.List<QualifiedValue>	read(java.util.List<TagPath> paths) Reads the values of the given tag paths.
void	removeTags(java.util.List<TagPath> tagPath) Removes the tags at the given tag paths.
void	subscribe(java.util.List<TagPath> paths, java.util.List<TagChangeListener> listeners) Subscribes to multiple paths at once, in order to be more efficient.
void	subscribe(TagPath path, TagChangeListener listener) Subscribes to the given tag path/property.
void	unsubscribe(java.util.List<TagPath> paths, java.util.List<TagChangeListener> listeners) Unsubscribes from multiple paths at once, in order to be more efficient.
void	unsubscribe(TagPath path, TagChangeListener listener) Unsubscribes from the given tag path/property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderSQLTagExecutor

public ProviderSQLTagExecutor(GatewayContext context,
                              AbstractStoreBasedTagProvider owner)

Method Detail

getGatewayContext

public GatewayContext getGatewayContext()

Specified by:

getGatewayContext in interface SQLTagsExecutor

getTagScriptManager

public TagScriptManager getTagScriptManager()

Specified by:

getTagScriptManager in interface SQLTagsExecutor

getName

public java.lang.String getName()

Specified by:

getName in interface SQLTagsExecutor

getObjectPath

public QualifiedPath getObjectPath()

Specified by:

getObjectPath in interface SQLTagsExecutor

getDisplayNameForPath

public java.lang.String getDisplayNameForPath(TagPath path)

Description copied from interface: SQLTagsExecutor

Returns a friendly, fully qualified path for the given tag.

Specified by:

getDisplayNameForPath in interface SQLTagsExecutor

Returns:

getDefaultDatasource

public java.lang.String getDefaultDatasource()

Specified by:

getDefaultDatasource in interface SQLTagsExecutor

getExecutionManager

public ExecutionManager getExecutionManager()

Specified by:

getExecutionManager in interface SQLTagsExecutor

getDefaultTagSource

public java.lang.String getDefaultTagSource()

Description copied from interface: SQLTagsExecutor

Returns the default tag source to be used when parsing tag reference paths. If null, the project default tag source will be used.

Specified by:

getDefaultTagSource in interface SQLTagsExecutor

Returns:

getTagErrorLogger

public org.apache.log4j.Logger getTagErrorLogger()

Specified by:

getTagErrorLogger in interface SQLTagsExecutor

getTagReferenceManager

public TagSubscriptionManager getTagReferenceManager()

getTagManager

public TagManagerBase getTagManager()

Description copied from interface: SQLTagsExecutor

Returns a tagmanagerbase that can be used to look up tag references. TagManagerBase might not be the right interface to return here, we really just want getTag, and subscribe.

Specified by:

getTagManager in interface SQLTagsExecutor

Returns:

getScriptManager

public ScriptManager getScriptManager()

Description copied from interface: SQLTagsExecutor

Returns the ScriptManager that can be used to execute Python scripts. We have this here because some SQLTags may operate under a project context, when others don't.

Specified by:

getScriptManager in interface SQLTagsExecutor

getSourceFixedPath

protected TagPath getSourceFixedPath(TagPath path)

read

public java.util.List<QualifiedValue> read(java.util.List<TagPath> paths)

Description copied from interface: TagSubscriptionManager

Reads the values of the given tag paths.

Specified by:

read in interface TagSubscriptionManager

Returns:

subscribe

public void subscribe(java.util.List<TagPath> paths,
                      java.util.List<TagChangeListener> listeners)

Description copied from interface: TagSubscriptionManager

Subscribes to multiple paths at once, in order to be more efficient. Paths and listeners must correspond.

Specified by:

subscribe in interface TagSubscriptionManager

unsubscribe

public void unsubscribe(java.util.List<TagPath> paths,
                        java.util.List<TagChangeListener> listeners)

Description copied from interface: TagSubscriptionManager

Unsubscribes from multiple paths at once, in order to be more efficient. Paths and listeners must correspond.

Specified by:

unsubscribe in interface TagSubscriptionManager

subscribe

public void subscribe(TagPath path,
                      TagChangeListener listener)

Description copied from interface: TagSubscriptionManager

Subscribes to the given tag path/property. Path should be fully qualified including tag source.

Specified by:

subscribe in interface TagSubscriptionManager

unsubscribe

public void unsubscribe(TagPath path,
                        TagChangeListener listener)

Description copied from interface: TagSubscriptionManager

Unsubscribes from the given tag path/property. Path should be fully qualified including tag source.

Specified by:

unsubscribe in interface TagSubscriptionManager

addTags

public void addTags(TagPath parentFolder,
                    java.util.List<TagNode> tag,
                    TagManagerBase.CollisionPolicy collisionPolicy)
             throws java.lang.Exception

Description copied from interface: TagManagerBase

Adds the given tags into the parent folder. Returns a list of TagPaths corresponding to the new path of each tag, in the order they were given.

Specified by:

addTags in interface TagManagerBase

Throws:

java.lang.Exception

browse

public java.util.List<Tag> browse(TagPath root)

Description copied from interface: TagCollection

Provides the tags located beneath the specified path. Returns an empty collection if no tags are present, null if the original path did not exist.

Specified by:

browse in interface TagCollection

Returns:

editTags

public void editTags(java.util.List<TagPath> paths,
                     TagDiff edit)
              throws java.lang.Exception

Description copied from interface: TagManagerBase

Applies the given TagDiff edit to the paths indicated

Specified by:

editTags in interface TagManagerBase

Throws:

java.lang.Exception

getTag

public Tag getTag(TagPath path)

Description copied from interface: TagCollection

Returns the tag located at a specific path. If the path doesn't exist, null will be returned.

Specified by:

getTag in interface TagCollection

Returns:

getTagDiagnostics

public TagDiagnostics getTagDiagnostics(TagPath path)

Description copied from interface: TagManagerBase

Returns the current diagnostic information for a given path. Returns null if path is not found.

Specified by:

getTagDiagnostics in interface TagManagerBase

Returns:

removeTags

public void removeTags(java.util.List<TagPath> tagPath)
                throws java.lang.Exception

Description copied from interface: TagManagerBase

Removes the tags at the given tag paths. Returns the listof tags tag that were removed, if any.

Specified by:

removeTags in interface TagManagerBase

Throws:

java.lang.Exception