com.inductiveautomation.ignition.client.sqltags.impl

Class ClientTagManagerImpl

java.lang.Object

com.inductiveautomation.ignition.client.sqltags.impl.ClientTagManagerImpl

All Implemented Interfaces:

ClientTagManager, TagCollection, TagManager, TagManagerBase, TagSubscriptionManager

public class ClientTagManagerImpl
extends java.lang.Object
implements ClientTagManager

The client tag manager manages all tags that clients can access, db tags and system tags

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ClientTagManagerImpl.ComplexTypeManagerWrapper This wrapper makes sure we always use fully qualified paths, inserting the source name if appropriate.

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

TagManagerBase.CollisionPolicy

Constructor Summary

Constructors

Constructor and Description
ClientTagManagerImpl(ClientContext app)

Method Summary

Modifier and Type	Method and Description
void	addScanClasses(java.lang.String provider, java.util.List<ScanClass> scanClasses) Adds the given scan classes to the system, replacing any existing ones with the same names.
void	addSubManager(TagProviderMeta meta, ClientSubManager manager)
void	addSystemSubManager(java.lang.String name, ClientSubManager manager)
void	addTags(TagPath parentFolder, java.util.List<TagNode> tags, TagManagerBase.CollisionPolicy policy) Adds the given tags into the parent folder.
boolean	areTagsEditable(java.util.List<TagPath> paths) Returns whether the specified tags can be edited, based on provider, or security settings.
java.util.List<Tag>	browse(TagPath root) Provides the tags located beneath the specified path.
BrowseResults	browseHistoricalTags(QualifiedPath root, BrowseFilter filter)
java.util.List<BrowseElement>	browseOPC(java.lang.String provider, BrowseElement root) Browses the OPC servers on the given provider.
void	editTags(java.util.List<TagPath> paths, TagDiff edit) Applies the given TagDiff edit to the paths indicated
java.util.List<java.lang.String>	getDrivers(java.lang.String provider) Gets the drivers under a given provider.
StatMetric	getLoadMetric()
protected ClientSubManager	getManager(java.lang.String name)
protected ClientSubManager	getManager(TagPath path)
StatMetric	getPollingMetric()
java.util.List<TagProviderMeta>	getProviderInformation()
TagProviderMeta	getProviderInformation(java.lang.String provider)
java.util.List<ScanClass>	getScanClasses(java.lang.String provider) Returns the scan classes for a given provider.
SystemTagManager	getSystemTags()
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.
java.util.List<Tag>	getTags(java.util.List<TagPath> paths) Returns the requested tags.
java.util.List<TagNode>	getTagsDeep(java.util.List<TagPath> paths) Returns a deep copy of the tag hierarchy under the given paths
ComplexTypeManager	getTypeManager(java.lang.String provider) Returns the type manager, or null if the provider doesn't support complex types
StatMetric	getValueChangeMetric()
void	modifyScanClass(java.lang.String provider, java.lang.String scName, ScanClass newDefinition) Edits the scan class, replacing the old one with the new definition.
java.util.List<QualifiedValue>	read(java.util.List<TagPath> paths) Reads the values of the given tag paths.
void	removeScanClasses(java.lang.String provider, java.util.List<java.lang.String> scanclassNames) Removes scan classes with the given names.
void	removeTags(java.util.List<TagPath> paths) Removes the tags at the given tag paths.
void	setPollingDelay(int millis)
void	shutdown()
void	startup()
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.
WriteOperation	write(TagPath path, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientTagManagerImpl

public ClientTagManagerImpl(ClientContext app)

Method Detail

setPollingDelay

public void setPollingDelay(int millis)

getManager

protected ClientSubManager getManager(TagPath path)

getManager

protected ClientSubManager getManager(java.lang.String name)

getSystemTags

public SystemTagManager getSystemTags()

shutdown

public void shutdown()

Specified by:

shutdown in interface ClientTagManager

startup

public void startup()

Specified by:

startup in interface ClientTagManager

getPollingMetric

public StatMetric getPollingMetric()

Specified by:

getPollingMetric in interface ClientTagManager

getLoadMetric

public StatMetric getLoadMetric()

Specified by:

getLoadMetric in interface ClientTagManager

getValueChangeMetric

public StatMetric getValueChangeMetric()

Specified by:

getValueChangeMetric in interface ClientTagManager

write

public WriteOperation write(TagPath path,
                            java.lang.Object value)

Specified by:

write in interface ClientTagManager

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:

browseOPC

public java.util.List<BrowseElement> browseOPC(java.lang.String provider,
                                               BrowseElement root)
                                        throws java.lang.Exception

Description copied from interface: TagManager

Browses the OPC servers on the given provider.

Specified by:

browseOPC in interface TagManager

Parameters:

provider - may be the name of a sqltags provider, or "name/driver" for the legacy sqltags system which could have multiple drivers under one provider.

root - location from which to browse.

Returns:

Throws:

java.lang.IllegalArgumentException - if provider doesn't exist.

java.lang.Exception

getDrivers

public java.util.List<java.lang.String> getDrivers(java.lang.String provider)
                                            throws java.lang.IllegalArgumentException

Description copied from interface: TagManager

Gets the drivers under a given provider. Only applicable to providers who can have multiple drivers, like LegacyProvider. Providers that don't, such as the internal one, will return an empty list.

Specified by:

getDrivers in interface TagManager

Returns:

Throws:

java.lang.IllegalArgumentException - if provider doesn't exist.

areTagsEditable

public boolean areTagsEditable(java.util.List<TagPath> paths)

Description copied from interface: ClientTagManager

Returns whether the specified tags can be edited, based on provider, or security settings.

Specified by:

areTagsEditable in interface ClientTagManager

getProviderInformation

public TagProviderMeta getProviderInformation(java.lang.String provider)

Specified by:

getProviderInformation in interface ClientTagManager

getProviderInformation

public java.util.List<TagProviderMeta> getProviderInformation()

Specified by:

getProviderInformation in interface TagManager

addScanClasses

public void addScanClasses(java.lang.String provider,
                           java.util.List<ScanClass> scanClasses)
                    throws java.lang.Exception

Description copied from interface: TagManager

Adds the given scan classes to the system, replacing any existing ones with the same names.

Specified by:

addScanClasses in interface TagManager

Parameters:

provider - where to add the scan classes.

Throws:

java.lang.IllegalArgumentException - if provider doesn't exist.

java.lang.Exception

modifyScanClass

public void modifyScanClass(java.lang.String provider,
                            java.lang.String scName,
                            ScanClass newDefinition)
                     throws java.lang.Exception

Description copied from interface: TagManager

Edits the scan class, replacing the old one with the new definition.

Specified by:

modifyScanClass in interface TagManager

Throws:

java.lang.Exception

getScanClasses

public java.util.List<ScanClass> getScanClasses(java.lang.String provider)
                                         throws java.lang.IllegalArgumentException

Description copied from interface: TagManager

Returns the scan classes for a given provider. If the provider doesn't exist, an IllegalArgumentException will be thrown.

Specified by:

getScanClasses in interface TagManager

Returns:

Throws:

java.lang.IllegalArgumentException - if provider doesn't exist.

removeScanClasses

public void removeScanClasses(java.lang.String provider,
                              java.util.List<java.lang.String> scanclassNames)

Description copied from interface: TagManager

Removes scan classes with the given names. Currently does not throw an error if the provider doesn't exist.

Specified by:

removeScanClasses in interface TagManager

Parameters:

provider - where to remove the scan classes from.

browseHistoricalTags

public BrowseResults browseHistoricalTags(QualifiedPath root,
                                          BrowseFilter filter)

Specified by:

browseHistoricalTags in interface ClientTagManager

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:

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:

getTags

public java.util.List<Tag> getTags(java.util.List<TagPath> paths)

Description copied from interface: ClientTagManager

Returns the requested tags. Unlike getTagsDeep, does not perform any processing on the tag. Multi-path version of getTag().

Specified by:

getTags in interface ClientTagManager

Returns:

getTypeManager

public ComplexTypeManager getTypeManager(java.lang.String provider)

Description copied from interface: ClientTagManager

Returns the type manager, or null if the provider doesn't support complex types

Specified by:

getTypeManager in interface ClientTagManager

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:

addTags

public void addTags(TagPath parentFolder,
                    java.util.List<TagNode> tags,
                    TagManagerBase.CollisionPolicy policy)
             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

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

removeTags

public void removeTags(java.util.List<TagPath> paths)
                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

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

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

getTagsDeep

public java.util.List<TagNode> getTagsDeep(java.util.List<TagPath> paths)
                                    throws java.lang.Exception

Returns a deep copy of the tag hierarchy under the given paths

Specified by:

getTagsDeep in interface ClientTagManager

Throws:

java.lang.Exception

addSubManager

public void addSubManager(TagProviderMeta meta,
                          ClientSubManager manager)

Specified by:

addSubManager in interface ClientTagManager

addSystemSubManager

public void addSystemSubManager(java.lang.String name,
                                ClientSubManager manager)

Specified by:

addSystemSubManager in interface ClientTagManager