Class NodeId
- java.lang.Object
-
- com.inductiveautomation.ignition.common.tags.NodeId
-
- All Implemented Interfaces:
java.io.Serializable
public class NodeId extends java.lang.Object implements java.io.Serializable
- Since:
- 8.0
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
NodeId.IdFactory
static class
NodeId.TestIdFactory
static class
NodeId.UuidIdFactory
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static NodeId
forChain(java.io.Serializable... ids)
static NodeId
fromString(java.lang.String value)
NodeId
getEntityId()
This returns the root entity id for the overall object.java.io.Serializable
getMemberId()
Returns the last portion of the node id, which is the specific id of the particular member.NodeId
getMemberNodeId()
NodeId
getOwner()
int
hashCode()
java.io.Serializable[]
idChain()
NodeId
inheritedMemberId(NodeId member)
Replaces the member's entity id with the entity id of this node id.boolean
isInherited()
boolean
isMember()
boolean
isMemberOf(NodeId other)
Returns true if this id is under the provided id.NodeId
memberId(NodeId child)
Takes a NodeId, which represents the id of an inherited node, and turns it into a member node of this id.NodeId
newChildId()
static NodeId
newId()
static NodeId
newId(java.io.Serializable name)
Used for testing only, the default factory will ignore the passed nameNodeId
newParentEntity(java.io.Serializable entityId)
static void
setIdFactory(NodeId.IdFactory factory)
java.lang.String
toString()
-
-
-
Method Detail
-
setIdFactory
public static void setIdFactory(NodeId.IdFactory factory)
-
newId
public static NodeId newId()
-
newId
public static NodeId newId(java.io.Serializable name)
Used for testing only, the default factory will ignore the passed name
-
newChildId
public NodeId newChildId()
-
forChain
public static NodeId forChain(java.io.Serializable... ids)
-
memberId
public NodeId memberId(NodeId child)
Takes a NodeId, which represents the id of an inherited node, and turns it into a member node of this id. This is used in the case of composite tags. For example, if we're node id 8, and we have an instance of udt 2, which has member 5, we would received "2.5" and return "8.2.5".
-
inheritedMemberId
public NodeId inheritedMemberId(NodeId member)
Replaces the member's entity id with the entity id of this node id.
-
newParentEntity
public NodeId newParentEntity(java.io.Serializable entityId)
-
getMemberId
public java.io.Serializable getMemberId()
Returns the last portion of the node id, which is the specific id of the particular member.
-
getMemberNodeId
public NodeId getMemberNodeId()
-
isInherited
public boolean isInherited()
-
isMember
public boolean isMember()
-
getOwner
public NodeId getOwner()
-
isMemberOf
public boolean isMemberOf(NodeId other)
Returns true if this id is under the provided id.
-
getEntityId
public NodeId getEntityId()
This returns the root entity id for the overall object.
-
idChain
public java.io.Serializable[] idChain()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
fromString
public static NodeId fromString(java.lang.String value)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
-