com.inductiveautomation.ignition.common.sqltags.tags

Class AbstractTag

java.lang.Object

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

All Implemented Interfaces:

MutableTag, Tag, TagObject, java.lang.Comparable<Tag>

Direct Known Subclasses:

AbstractClientTag, FolderTag

public abstract class AbstractTag
extends java.lang.Object
implements MutableTag

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessRightsType	accessRights
protected java.util.Map<TagProp,java.lang.Object>	attributes
protected boolean	enabled
protected TagEventScripts	eventScripts
protected java.lang.String	name
protected TagPermissionsModel	permissionModel
protected DataType	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTag()
protected	AbstractTag(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addChild(Tag child)
protected TagValue	coerceValue(TagValue value) Coerces the value inside the argument TagValue to this tag's datatype, if that value is not null.
int	compareTo(Tag that)
AccessRightsType	getAccessRights() Gets the type of access rights for this tag
TagValue	getAttribute(TagProp prop) Gets the value of the given tag attribute.
Tag	getChild(java.lang.String name)
java.util.List<? extends Tag>	getChildren()
DataType	getDataType() Returns the datatype of this tag's value property
TagEventScripts	getEventScripts()
java.lang.String	getName() Returns the name of the tag.
TagPermissionsModel	getPermissionModel() Returns this tags permission model, if any
java.util.Map<TagProp,java.lang.Object>	getRawAttributes()
TagValue	getValue() Returns the value in qualified form- along with quality and timestamp.
boolean	isAlarmingSupported() Returns true if this tag supports alarming, false otherwise
boolean	isEnabled() Returns the enabled bit for this tag
static boolean	isValidName(java.lang.String name) Returns true if the given name is a valid name for a SQLTag or not.
static void	main(java.lang.String[] agrs)
Tag	removeChild(java.lang.String name)
static java.lang.String	sanitizeName(java.lang.String name) Takes a string and replaces any illegal characters with underscores.
void	setAccessRights(AccessRightsType accessRights) Sets the type of access rights for this tag.
void	setAttribute(TagProp prop, TagValue value) Sets the value of the given tag attribute.
void	setDataType(DataType type) Sets the data type for this tag.
void	setEnabled(boolean en) Sets this tag enabled/disabled
void	setEventScripts(TagEventScripts scripts)
void	setName(java.lang.String name) Sets the name of this tag
void	setPermissionModel(TagPermissionsModel permissionModel) Sets the tag's permission model
void	setRawAttributes(java.util.Map<TagProp,java.lang.Object> value)
void	setValue(TagValue value) Sets this tags value.

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.sqltags.model.MutableTag

setAlarmStates

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

getAlarmStates, getType

Field Detail

attributes

protected java.util.Map<TagProp,java.lang.Object> attributes

type

protected DataType type

accessRights

protected AccessRightsType accessRights

permissionModel

protected TagPermissionsModel permissionModel

eventScripts

protected TagEventScripts eventScripts

enabled

protected boolean enabled

name

protected java.lang.String name

Constructor Detail

AbstractTag

protected AbstractTag()

AbstractTag

protected AbstractTag(java.lang.String name)

Method Detail

getChild

public Tag getChild(java.lang.String name)

removeChild

public Tag removeChild(java.lang.String name)

getName

public java.lang.String getName()

Description copied from interface: Tag

Returns the name of the tag.

Specified by:

getName in interface Tag

Specified by:

getName in interface TagObject

setName

public void setName(java.lang.String name)

Description copied from interface: MutableTag

Sets the name of this tag

Specified by:

setName in interface MutableTag

getValue

public TagValue getValue()

Description copied from interface: Tag

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

Specified by:

getValue in interface Tag

Returns:

setValue

public void setValue(TagValue value)
              throws java.lang.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:

setValue in interface MutableTag

Throws:

java.lang.ClassCastException

coerceValue

protected TagValue coerceValue(TagValue value)
                        throws java.lang.ClassCastException

Coerces the value inside the argument TagValue to this tag's datatype, if that value is not null.

Throws:

java.lang.ClassCastException

getDataType

public DataType getDataType()

Description copied from interface: Tag

Returns the datatype of this tag's value property

Specified by:

getDataType in interface Tag

Returns:

isEnabled

public boolean isEnabled()

Description copied from interface: Tag

Returns the enabled bit for this tag

Specified by:

isEnabled in interface Tag

Returns:

setEnabled

public void setEnabled(boolean en)

Description copied from interface: MutableTag

Sets this tag enabled/disabled

Specified by:

setEnabled in interface MutableTag

setDataType

public void setDataType(DataType type)

Description copied from interface: MutableTag

Sets the data type for this tag. The existing value will most likely be lost.

Specified by:

setDataType in interface MutableTag

getChildren

public java.util.List<? extends Tag> getChildren()

addChild

public void addChild(Tag child)

getAttribute

public TagValue getAttribute(TagProp prop)

Description copied from interface: Tag

Gets the value of the given tag attribute.

Specified by:

getAttribute in interface Tag

Returns:

setAttribute

public void setAttribute(TagProp prop,
                         TagValue value)
                  throws java.lang.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

Throws:

java.lang.ClassCastException

getRawAttributes

public java.util.Map<TagProp,java.lang.Object> getRawAttributes()

setRawAttributes

public void setRawAttributes(java.util.Map<TagProp,java.lang.Object> value)

getAccessRights

public AccessRightsType getAccessRights()

Description copied from interface: Tag

Gets the type of access rights for this tag

Specified by:

getAccessRights in interface Tag

Returns:

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

getPermissionModel

public TagPermissionsModel getPermissionModel()

Description copied from interface: Tag

Returns this tags permission model, if any

Specified by:

getPermissionModel in interface Tag

Returns:

setPermissionModel

public void setPermissionModel(TagPermissionsModel permissionModel)

Description copied from interface: MutableTag

Sets the tag's permission model

Specified by:

setPermissionModel in interface MutableTag

getEventScripts

public TagEventScripts getEventScripts()

Specified by:

getEventScripts in interface Tag

setEventScripts

public void setEventScripts(TagEventScripts scripts)

Specified by:

setEventScripts in interface MutableTag

isAlarmingSupported

public boolean isAlarmingSupported()

Description copied from interface: Tag

Returns true if this tag supports alarming, false otherwise

Specified by:

isAlarmingSupported in interface Tag

Returns:

compareTo

public int compareTo(Tag that)

Specified by:

compareTo in interface java.lang.Comparable<Tag>

isValidName

public static boolean isValidName(java.lang.String name)

Returns true if the given name is a valid name for a SQLTag or not. Valid names start with a letter, and contain any of : letters, digits, underscore, space, parenthesis, single quote, and dash

sanitizeName

public static java.lang.String sanitizeName(java.lang.String name)
                                     throws java.lang.IllegalArgumentException

Takes a string and replaces any illegal characters with underscores. Any name that cannot be sanitized will throw an IllegalArgumentException.

Throws:

java.lang.IllegalArgumentException

main

public static void main(java.lang.String[] agrs)