Interface Node

All Superinterfaces:
Comparable<Node>, Serializable, TetradSerializable
All Known Subinterfaces:
Variable
All Known Implementing Classes:
AbstractVariable, ContinuousVariable, DiscreteVariable, GraphNode
public interface Node extends TetradSerializable, Comparable<Node>
Represents an object with a name, node type, and position that can serve as a node in a graph.
Version:
$Id: $Id
Author:
josephramsey
See Also:

  • Field Details

    • ALPHA

      static final Pattern ALPHA
      Constant ALPHA

    • ALPHA_NUM

      static final Pattern ALPHA_NUM
      Constant ALPHA_NUM

    • LAG

      static final Pattern LAG
      Constant LAG

    • serialVersionUID

      static final long serialVersionUID
      Constant serialVersionUID=23L
      See Also:

  • Method Details

    • getName

      String getName()
      Returns the name of this node.
      Returns:
      the name of the node.

    • setName

      void setName(String name)
      Sets the name of this node.
      Parameters:
      name - the name of this node.

    • getRank

      default int getRank()
      Returns the rank, or -1 if no rank is set.
      Returns:
      the rank of the node

    • setRank

      default void setRank(int rank)
      Sets the rank, or -1 if no rank is set.
      Parameters:
      rank - the rank to set
      Throws:
      UnsupportedOperationException - if the node type does not support setting a rank.

    • getDisplayName

      default String getDisplayName()
      Returns the display name.
      Returns:
      the display name

    • getNodeType

      NodeType getNodeType()
      Returns the node type for this node.
      Returns:
      the node type for this node.

    • setNodeType

      void setNodeType(NodeType nodeType)
      Sets the node type for this node.
      Parameters:
      nodeType - the node type for this node.

    • getSelectionBias

      boolean getSelectionBias()
      Returns the selection bias status for this node.
      Returns:
      the selection bias status for this node.

    • setSelectionBias

      void setSelectionBias(boolean selectionBias)
      Returns the selection bias status for this node.
      Parameters:
      selectionBias - the selection bias status for this node.

    • getNodeVariableType

      NodeVariableType getNodeVariableType()
      Returns the node shape for this node.
      Returns:
      the intervention type

    • setNodeVariableType

      void setNodeVariableType(NodeVariableType nodeVariableType)
      Sets the type (domain, interventional status, interventional value..) for this node variable
      Parameters:
      nodeVariableType - the type (domain, interventional status, interventional value..) for this node variable

    • toString

      String toString()
      Returns the intervention type for this node.
      Overrides:
      toString in class Object
      Returns:
      a string representation of the node.

    • getCenterX

      int getCenterX()
      Returns the x coordinate of the center of this node.
      Returns:
      the x coordinate of the center of the node.

    • setCenterX

      void setCenterX(int centerX)
      Sets the x coordinate of the center of this node.
      Parameters:
      centerX - This coordinate.

    • getCenterY

      int getCenterY()
      Returns the y coordinate of the center of this node.
      Returns:
      the y coordinate of the center of the node.

    • setCenterY

      void setCenterY(int centerY)
      Sets the y coordinate of the center of this node.
      Parameters:
      centerY - This coordinate.

    • setCenter

      void setCenter(int centerX, int centerY)
      Sets the (x, y) coordinates of the center of this node.
      Parameters:
      centerX - The x coordinate.
      centerY - The y coordinate.

    • addPropertyChangeListener

      void addPropertyChangeListener(PropertyChangeListener l)
      Adds a property change listener.
      Parameters:
      l - This listener.

    • hashCode

      int hashCode()
      Removes a property change listener.
      Overrides:
      hashCode in class Object
      Returns:
      a hashcode for this variable.

    • equals

      boolean equals(Object o)
      Tests whether this variable is equal to the given variable.
      Overrides:
      equals in class Object
      Parameters:
      o - a Object object
      Returns:
      true iff this variable is equal to the given variable.

    • like

      Node like(String name)
      Creates a new node of the same type as this one with the given name.
      Parameters:
      name - the name of the new node.
      Returns:
      the new node.

    • compareTo

      default int compareTo(Node node)
      Compares this node to the given node by name, using the shared display order for possibly-lagged names: unlagged names first, then lagged names in order of increasing lag, with natural ordering of base names within a lag group and the raw name as a final tiebreaker, so distinct names never compare equal. Never throws.

      This replaces a bucketed comparison that ordered names by concatenating all their digits, under which distinct lagged names such as "X12:3" and "X1:23" compared equal (both reduce to the digit string "123"), names with digit runs too long for an int crashed with NumberFormatException, and cross-bucket comparisons fell back to raw string order in ways that could violate transitivity.

      Specified by:
      compareTo in interface Comparable<Node>
      Parameters:
      node - the node to be compared.
      Returns:
      a negative integer, zero, or a positive integer as this node's name orders before, the same as, or after the given node's name.

    • getAllAttributes

      Map<String,Object> getAllAttributes()

      getAllAttributes.

      Returns:
      a Map object

    • getAttribute

      Object getAttribute(String key)

      getAttribute.

      Parameters:
      key - a String object
      Returns:
      a Object object

    • removeAttribute

      void removeAttribute(String key)

      removeAttribute.

      Parameters:
      key - a String object

    • addAttribute

      void addAttribute(String key, Object value)

      addAttribute.

      Parameters:
      key - a String object
      value - a Object object