public class ComplexTagCreateConfig extends ComplexTagConfig implements MutableTag
Constructor and Description |
---|
ComplexTagCreateConfig(ComplexTypeManager manager,
ComplexTagDefinition model)
Creates the config for a new ComplexTag.
|
Modifier and Type | Method and Description |
---|---|
void |
addChild(TagNode tag) |
void |
addChildren(java.util.Collection<TagNode> tags) |
java.util.List<Member> |
addMember(java.lang.String parentFolderUID,
Tag member)
Adds a member to this type, located at the specified folder path.
|
void |
applyDiff(TagDiff diff) |
protected ComplexTagDefinition |
buildFullModel(ComplexTag base)
Builds the fully formed version of the starting template.
|
int |
compareTo(Tag o) |
boolean |
equals(java.lang.Object obj) |
AccessRightsType |
getAccessRights()
Gets the type of access rights for this tag
|
AlarmConfiguration |
getAlarmStates()
Returns the list of alarm states for this tag
|
TagValue |
getAttribute(TagProp prop)
Gets the value of the given tag attribute.
|
TagNode |
getChild(java.lang.String name) |
java.util.List<? extends TagNode> |
getChildren() |
Quality |
getDataQuality() |
DataType |
getDataType()
Returns the datatype of this tag's value property
|
java.lang.Object |
getEditForCommit()
Returns the object to be committed to the gateway.
|
boolean |
getEnabled() |
TagEventScripts |
getEventScripts() |
PropertySet |
getExtendedProperties() |
TagPath |
getFullyQualifiedType()
Returns the type id of this tag.
|
Member |
getMember(java.lang.String memberUID)
Returns the member of this complex tag with the given UID, or null if the member doesn't exist.
|
MutableTag |
getMemberEdit(java.lang.String memberUID) |
java.util.Collection<Member> |
getMembers(boolean opaque)
If opaque, member config objects will already have overrides applied to them.
|
java.lang.String |
getName()
Returns the name of the tag.
|
PropertySet |
getOverrides(java.lang.String memberUID)
Retrieves the overrides for the specified member of this complex type.
|
TagPermissionsModel |
getPermissionModel()
Returns this tags permission model, if any
|
OverrideMap |
getPropertyOverrides() |
TagType |
getType()
Returns the type of this tag.
|
TagValue |
getValue()
Returns the value in qualified form- along with quality and timestamp.
|
int |
hashCode() |
boolean |
isAlarmingSupported()
Returns true if this tag supports alarming, false otherwise
|
boolean |
isEnabled()
Returns the enabled bit for this tag
|
boolean |
isTypeDef()
Returns whether this complex type is a type definition, or an instance.
|
Tag |
removeChild(java.lang.String name) |
void |
removeMember(java.lang.String memberUID)
Removes just the specified member from the model.
|
void |
setAccessRights(AccessRightsType type)
Sets the type of access rights for this tag.
|
void |
setAlarmStates(AlarmConfiguration config) |
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 |
setType(TagType type) |
void |
setValue(TagValue value)
Sets this tags value.
|
java.lang.String |
toBase64String() |
java.lang.String |
toString() |
protected ComplexTagDefinition |
updateModelForNewBase(ComplexTagDefinition baseDef)
For new tags, we may have added members or changed properties.
|
addCompositeMembersToDef, addMember, convertParentType, getModel, getTypeManager, mergeWithParent, setModel
public ComplexTagCreateConfig(ComplexTypeManager manager, ComplexTagDefinition model)
manager
- model
- protected ComplexTagDefinition buildFullModel(ComplexTag base)
base
- public java.lang.String getName()
Tag
public TagPath getFullyQualifiedType()
ComplexTag
getFullyQualifiedType
in interface ComplexTag
public java.util.Collection<Member> getMembers(boolean opaque)
ComplexTag
getMembers
in interface ComplexTag
getMembers
in class ComplexTagConfig
public TagType getType()
Tag
public DataType getDataType()
Tag
getDataType
in interface Tag
public Member getMember(java.lang.String memberUID)
ComplexTag
getMember
in interface ComplexTag
public boolean isEnabled()
Tag
public TagValue getValue()
Tag
public boolean isTypeDef()
ComplexTag
isTypeDef
in interface ComplexTag
public PropertySet getOverrides(java.lang.String memberUID)
ComplexTag
getOverrides
in interface ComplexTag
public AccessRightsType getAccessRights()
Tag
getAccessRights
in interface Tag
public TagPermissionsModel getPermissionModel()
Tag
getPermissionModel
in interface Tag
public AlarmConfiguration getAlarmStates()
Tag
getAlarmStates
in interface Tag
public TagEventScripts getEventScripts()
getEventScripts
in interface Tag
public void setAlarmStates(AlarmConfiguration config)
setAlarmStates
in interface MutableTag
public void setEventScripts(TagEventScripts scripts)
setEventScripts
in interface MutableTag
public boolean isAlarmingSupported()
Tag
isAlarmingSupported
in interface Tag
public TagValue getAttribute(TagProp prop)
Tag
getAttribute
in interface Tag
public int compareTo(Tag o)
compareTo
in interface java.lang.Comparable<Tag>
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public void addChild(TagNode tag)
public void addChildren(java.util.Collection<TagNode> tags)
public Tag removeChild(java.lang.String name)
public TagNode getChild(java.lang.String name)
public void setValue(TagValue value)
MutableTag
setValue
in interface MutableTag
public void setAccessRights(AccessRightsType type)
MutableTag
setAccessRights
in interface MutableTag
public java.util.List<? extends TagNode> getChildren()
public Quality getDataQuality()
public void setType(TagType type)
public boolean getEnabled()
public void setAttribute(TagProp prop, TagValue value) throws java.lang.ClassCastException
MutableTag
setAttribute
in interface MutableTag
java.lang.ClassCastException
public void setDataType(DataType type)
MutableTag
setDataType
in interface MutableTag
public void setEnabled(boolean en)
MutableTag
setEnabled
in interface MutableTag
public void setName(java.lang.String name)
MutableTag
setName
in interface MutableTag
setName
in interface MutableComplexTag
public void setPermissionModel(TagPermissionsModel permissionModel)
MutableTag
setPermissionModel
in interface MutableTag
public PropertySet getExtendedProperties()
public OverrideMap getPropertyOverrides()
public void applyDiff(TagDiff diff)
public java.lang.String toBase64String() throws java.io.IOException
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.List<Member> addMember(java.lang.String parentFolderUID, Tag member)
MutableComplexTag
addMember
in interface MutableComplexTag
addMember
in class ComplexTagConfig
public void removeMember(java.lang.String memberUID)
ComplexTagConfig
removeMember
in interface MutableComplexTag
removeMember
in class ComplexTagConfig
public MutableTag getMemberEdit(java.lang.String memberUID)
getMemberEdit
in class ComplexTagConfig
public java.lang.Object getEditForCommit()
ComplexTagConfig
getEditForCommit
in class ComplexTagConfig
protected ComplexTagDefinition updateModelForNewBase(ComplexTagDefinition baseDef)
updateModelForNewBase
in class ComplexTagConfig