com.inductiveautomation.ignition.gateway.sqltags.model

Class TagSubscriptionModel

java.lang.Object

com.inductiveautomation.ignition.gateway.sqltags.model.TagSubscriptionModel

public class TagSubscriptionModel
extends java.lang.Object

The TagSubscriptionModel holds subscriptions to tags, broken up by provider. Providers can add listeners in order to be notified of subscription changes. Subscription change notifications are published on asynchronously

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TagSubscriptionModel.ChangeNotificationJob

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,javax.swing.event.EventListenerList>	listenerLists SynchronizedMap
protected java.util.Map<java.lang.String,java.util.Set<TagSubscription>>	subscriptions SyncronizedMap - Key on both of these maps is the source name.

Constructor Summary

Constructors

Constructor and Description
TagSubscriptionModel(GatewayContext context)

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.String sourceName, TagSubscriptionChangeListener listener) Adds the listener to the specified source.
java.util.Map<java.lang.String,java.util.Set<TagSubscription>>	getAllSubscriptions() Returns an immutable map of all subscriptions this model has
protected javax.swing.event.EventListenerList	getListenerList(java.lang.String sourceName) gets the listener list for the given server, and creates one if one doesn't exist
protected java.lang.String	getServerPathForNode(TagPath node)
java.util.Collection<TagSubscription>	getSubscriptions(java.lang.String sourceName) Returns the list of subscriptions for a given source
void	removeListener(java.lang.String sourceName, TagSubscriptionChangeListener listener)
void	subscribe(java.util.List<TagPath> paths, java.util.List<TagChangeListener> listeners)
void	subscribe(TagPath path, TagChangeListener listener)
void	unsubscribe(java.util.List<TagPath> paths, java.util.List<TagChangeListener> listeners)
void	unsubscribe(TagPath path, TagChangeListener listener)
protected java.util.List<TagSubscription>	zipper(java.util.List<TagPath> paths, java.util.List<TagChangeListener> listeners)

Methods inherited from class java.lang.Object

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

Field Detail

subscriptions

protected java.util.Map<java.lang.String,java.util.Set<TagSubscription>> subscriptions

SyncronizedMap - Key on both of these maps is the source name.

listenerLists

protected java.util.Map<java.lang.String,javax.swing.event.EventListenerList> listenerLists

SynchronizedMap

Constructor Detail

TagSubscriptionModel

public TagSubscriptionModel(GatewayContext context)

Method Detail

getServerPathForNode

protected java.lang.String getServerPathForNode(TagPath node)

getSubscriptions

public java.util.Collection<TagSubscription> getSubscriptions(java.lang.String sourceName)

Returns the list of subscriptions for a given source

getAllSubscriptions

public java.util.Map<java.lang.String,java.util.Set<TagSubscription>> getAllSubscriptions()

Returns an immutable map of all subscriptions this model has

getListenerList

protected javax.swing.event.EventListenerList getListenerList(java.lang.String sourceName)

gets the listener list for the given server, and creates one if one doesn't exist

addListener

public void addListener(java.lang.String sourceName,
                        TagSubscriptionChangeListener listener)

Adds the listener to the specified source. Does NOT call the listener with the initial state. The entity adding the listener should use getSubscriptions() to get the current subscriptions, if necessary.

removeListener

public void removeListener(java.lang.String sourceName,
                           TagSubscriptionChangeListener listener)

subscribe

public void subscribe(TagPath path,
                      TagChangeListener listener)

unsubscribe

public void unsubscribe(TagPath path,
                        TagChangeListener listener)

subscribe

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

unsubscribe

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

zipper

protected java.util.List<TagSubscription> zipper(java.util.List<TagPath> paths,
                                                 java.util.List<TagChangeListener> listeners)