Package com.inductiveautomation.factorypmi.application.sqltags

Class AbstractClientTag

java.lang.Object

com.inductiveautomation.ignition.common.sqltags.tags.AbstractTag

com.inductiveautomation.factorypmi.application.sqltags.AbstractClientTag

All Implemented Interfaces:

ClientTag, Diagnosable, MutableTag, Tag, TagNode, TagScriptMonitor, Comparable<Tag>

Direct Known Subclasses:

AbstractClientSystemTag, ArrayIndexTag, ClientTagFolder, ProjectTag

public abstract class AbstractClientTag
extends AbstractTag
implements ClientTag, TagScriptMonitor, Diagnosable

Field Summary

Fields

Modifier and Type	Field	Description
protected VisionClientContext	appContext
protected boolean	deleted	Turned true when this tag is deleted so that the correct quality can be returned
protected static final LoggerEx	LOGGER
protected String	name	The name of this tag
protected TagPath	pathContext	Tag path that points toward my parent, null if I'm the root

Fields inherited from class com.inductiveautomation.ignition.common.sqltags.tags.AbstractTag

accessRights, attributes, enabled, eventScripts, permissionModel, type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractClientTag(String name, DataType dataType, QualifiedValue value)

Method Summary

Modifier and Type	Method	Description
void	applyDiff(TagDiff diff)	Applies the diff to this tag, and fires one change at the end.
protected void	checkName(String name)
ClientTag	findChild(String tagName)	Attempts to find a tag with the given name (case insensitive).
protected void	fireScriptEvent(String id, Object... params)
void	fireTagChange(Property<?> prop)
AlarmConfiguration	getAlarmStates()	Returns the list of alarm states for this tag
QualifiedValue	getAttribute(Property<?> prop)	Gets the value of the given tag attribute.
List<? extends ClientTag>	getChildren()	Returns a list of children.
QualifiedValue	getCurrentValue()	Returns the value in qualified form- along with quality and timestamp.
String	getName()	Returns the name of the tag.
TagPath	getPath()
QualifiedValue	getValueRaw()	Gets the tag's current value, skipping enabled and security checks.
boolean	hasPermission(boolean write)	Returns true if the currently logged in user has permission for this tag, either for read or write access
boolean	isAlarmingSupported()
void	notifyTagDeleted()	Called when this tag is removed.
void	onScriptError(String id, String message, Exception error)
void	onScriptSuccess(String id)
Tag	removeChild(String tagName)	Removes the child with the given name (case insensitive).
void	sampleDiagnostics(DiagnosticsSample sample)	Provides the sample upon which the object can set diagnostics information.
void	setAccessRights(AccessRightsType accessRights)	Sets the type of access rights for this tag.
void	setAlarmStates(AlarmConfiguration config)
void	setAlarmStates(AlarmStateList list)
void	setAttribute(Property<?> prop, QualifiedValue value)	Sets the value of the given tag attribute.
void	setCurrentValue(QualifiedValue newValue)	Sets this tags value.
void	setEnabled(boolean enabled)	Sets this tag enabled/disabled
void	setEventScripts(TagEventScripts scripts)
void	setName(String name)	Sets the name of this tag
void	setTypeAndValue(DataType type, QualifiedValue value)
void	setTypeAndValue(DataType type, TagValue value)	Deprecated.
void	setTypeAndValue(DataType type, Object value)	Deprecated. no longer used, see setTypeAndValue(DataType, QualifiedValue).
void	startBinding(VisionClientContext appContext, TagPath pathContext, TagChangeListener rootListener)	Starts any binding for the tag, such as an expression binding or a SQL query binding
void	stopBinding()	Stops any binding activities for this tag
void	transferState(ClientTag otherTag)	Transfers listeners and values to another tag.
protected void	updateRuntimeQuality(int flag, boolean on)

Methods inherited from class com.inductiveautomation.ignition.common.sqltags.tags.AbstractTag

addChild, coerceValue, compareTo, getAccessRights, getChild, getDataType, getEventScripts, getPermissionModel, getRawAttributes, isEnabled, main, setDataType, setPermissionModel, setRawAttributes, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.factorypmi.application.sqltags.ClientTag

addChild

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.MutableTag

setDataType

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.model.Tag

getAccessRights, getDataType, getEventScripts, getPermissionModel, getType, isEnabled

Field Details

LOGGER

protected static final LoggerEx LOGGER

name

protected String name

The name of this tag

deleted

protected boolean deleted

Turned true when this tag is deleted so that the correct quality can be returned

appContext

protected VisionClientContext appContext

pathContext

protected TagPath pathContext

Tag path that points toward my parent, null if I'm the root

Constructor Details

AbstractClientTag

protected AbstractClientTag(String name,
 DataType dataType,
 QualifiedValue value)

Method Details

applyDiff

public void applyDiff(TagDiff diff)

Applies the diff to this tag, and fires one change at the end.

Specified by:

applyDiff in interface ClientTag

getChildren

public List<? extends ClientTag> getChildren()

Description copied from interface: TagNode

Returns a list of children.

Specified by:

getChildren in interface TagNode

Overrides:

getChildren in class AbstractTag

Returns:

children, NULL if not a folder.

getName

public String getName()

Description copied from interface: Tag

Returns the name of the tag.

Specified by:

getName in interface Tag

Overrides:

getName in class AbstractTag

checkName

protected void checkName(String name)

setName

public void setName(String name)

Description copied from interface: MutableTag

Sets the name of this tag

Specified by:

setName in interface MutableTag

Overrides:

setName in class AbstractTag

findChild

public ClientTag findChild(String tagName)

Description copied from interface: ClientTag

Attempts to find a tag with the given name (case insensitive).

Specified by:

findChild in interface ClientTag

removeChild

public Tag removeChild(String tagName)

Description copied from interface: ClientTag

Removes the child with the given name (case insensitive). Will throw an UnsupportedOperationException on anything but a folder tag. Returns the tag removed, or null if no tag by the given name was found.

Specified by:

removeChild in interface ClientTag

Overrides:

removeChild in class AbstractTag

getAttribute

public QualifiedValue getAttribute(Property<?> prop)

Description copied from interface: Tag

Gets the value of the given tag attribute.

Specified by:

getAttribute in interface Tag

Overrides:

getAttribute in class AbstractTag

setAttribute

public void setAttribute(Property<?> prop,
 QualifiedValue value)
                  throws ClassCastException

Description copied from interface: MutableTag

Sets the value of the given tag attribute. If the type of the argument is incorrect, an ClassCastException will be thrown.

Specified by:

setAttribute in interface MutableTag

Overrides:

setAttribute in class AbstractTag

Throws:

ClassCastException

setTypeAndValue

@Deprecated
public void setTypeAndValue(DataType type,
 Object value)

Deprecated.

no longer used, see setTypeAndValue(DataType, QualifiedValue).

For backwards compatability - this function is called during deserialization

setTypeAndValue

@Deprecated
public void setTypeAndValue(DataType type,
 TagValue value)

Deprecated.

setTypeAndValue

public void setTypeAndValue(DataType type,
 QualifiedValue value)

setCurrentValue

public void setCurrentValue(QualifiedValue newValue)
                     throws ClassCastException

Description copied from interface: MutableTag

Sets this tags value. Will throw an ClassCastException if the value cannot be coerced into the datatype of this tag.

Specified by:

setCurrentValue in interface MutableTag

Overrides:

setCurrentValue in class AbstractTag

Throws:

ClassCastException

getCurrentValue

public QualifiedValue getCurrentValue()

Description copied from interface: Tag

Returns the value in qualified form- along with quality and timestamp.

Specified by:

getCurrentValue in interface Tag

Overrides:

getCurrentValue in class AbstractTag

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: MutableTag

Sets this tag enabled/disabled

Specified by:

setEnabled in interface MutableTag

Overrides:

setEnabled in class AbstractTag

getValueRaw

public QualifiedValue getValueRaw()

Gets the tag's current value, skipping enabled and security checks. Used for serialization. See ProjectTagDelegate.

hasPermission

public boolean hasPermission(boolean write)

Returns true if the currently logged in user has permission for this tag, either for read or write access

Specified by:

hasPermission in interface ClientTag

setAccessRights

public void setAccessRights(AccessRightsType accessRights)

Description copied from interface: MutableTag

Sets the type of access rights for this tag.

Specified by:

setAccessRights in interface MutableTag

Overrides:

setAccessRights in class AbstractTag

setEventScripts

public void setEventScripts(TagEventScripts scripts)

Specified by:

setEventScripts in interface MutableTag

Overrides:

setEventScripts in class AbstractTag

getAlarmStates

public AlarmConfiguration getAlarmStates()

Description copied from interface: Tag

Returns the list of alarm states for this tag

Specified by:

getAlarmStates in interface Tag

setAlarmStates

public void setAlarmStates(AlarmConfiguration config)

Specified by:

setAlarmStates in interface MutableTag

isAlarmingSupported

public boolean isAlarmingSupported()

Overrides:

isAlarmingSupported in class AbstractTag

setAlarmStates

public void setAlarmStates(AlarmStateList list)

getPath

public TagPath getPath()

onScriptSuccess

public void onScriptSuccess(String id)

Specified by:

onScriptSuccess in interface TagScriptMonitor

onScriptError

public void onScriptError(String id,
 String message,
 Exception error)

Specified by:

onScriptError in interface TagScriptMonitor

startBinding

public void startBinding(VisionClientContext appContext,
 TagPath pathContext,
 TagChangeListener rootListener)

Description copied from interface: ClientTag

Starts any binding for the tag, such as an expression binding or a SQL query binding

Specified by:

startBinding in interface ClientTag

stopBinding

public void stopBinding()

Description copied from interface: ClientTag

Stops any binding activities for this tag

Specified by:

stopBinding in interface ClientTag

sampleDiagnostics

public void sampleDiagnostics(DiagnosticsSample sample)

Description copied from interface: Diagnosable

Provides the sample upon which the object can set diagnostics information. It is expected that the calling object will first call getSubSample() in order to specify a useful identifier for this object's data.

Specified by:

sampleDiagnostics in interface Diagnosable

transferState

public void transferState(ClientTag otherTag)

Description copied from interface: ClientTag

Transfers listeners and values to another tag. Used when tag root is changed. Should transfer recursively - that is, transfer direct listeners, and then go through children, see if this tag has the same child, and transfer those listeners too

Specified by:

transferState in interface ClientTag

updateRuntimeQuality

protected void updateRuntimeQuality(int flag,
 boolean on)

notifyTagDeleted

public void notifyTagDeleted()

Description copied from interface: ClientTag

Called when this tag is removed. Should notify all subscribers that it no longer exists

Specified by:

notifyTagDeleted in interface ClientTag

fireTagChange

public void fireTagChange(Property<?> prop)

fireScriptEvent

protected void fireScriptEvent(String id,
 Object... params)