Package com.inductiveautomation.ignition.common.tags

Class NodeId

java.lang.Object
com.inductiveautomation.ignition.common.tags.NodeId
All Implemented Interfaces:
Serializable
public class NodeId extends Object implements Serializable
Since:
8.0
See Also:

  • Method Details

    • setIdFactory

      public static void setIdFactory(NodeId.IdFactory factory)

    • newId

      public static NodeId newId()

    • newId

      public static NodeId newId(Serializable name)
      Used for testing only, the default factory will ignore the passed name

    • newChildId

      public NodeId newChildId()

    • forChain

      public static NodeId forChain(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(Serializable entityId)

    • getMemberId

      public 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 Serializable[] idChain()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • fromString

      public static NodeId fromString(String value)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object