Node (GEF4 Graph API Reference)

java.lang.Object
- org.eclipse.gef4.graph.Node

All Implemented Interfaces:

org.eclipse.gef4.common.properties.IPropertyChangeNotifier
```
public final class Node
extends java.lang.Object
implements org.eclipse.gef4.common.properties.IPropertyChangeNotifier
```
A Node represents a vertex within a Graph.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Node.Builder
The Node.Builder can be used to construct a Node little by little.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Node.Builder` The `Node.Builder` can be used to construct a `Node` little by little.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTES_PROPERTY` The property name that is used to notify change listeners about changes made to the attributes of this Node.
`protected java.beans.PropertyChangeSupport`	`pcs` The `PropertyChangeSupport` which handles (un-)registration of `PropertyChangeListener`s and firing of `PropertyChangeEvent` s.

Constructor Summary

Constructors
Constructor and Description
`Node()` Constructs a new `Node`.
`Node(java.util.Map<java.lang.String,java.lang.Object> attrs)` Constructs a new `Node` and copies the given attributes into the `attributes map` of this `Node`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`
`boolean`	`equals(java.lang.Object that)`
`java.util.Set<? extends Edge>`	`getAllIncomingEdges()` Returns all incoming `Edge`s of this `Node`.
`java.util.Set<Node>`	`getAllNeighbors()` Returns all neighbors of this `Node`.
`java.util.Set<? extends Edge>`	`getAllOutgoingEdges()` Returns all outgoing `Edge`s of this `Node`.
`java.util.Set<? extends Node>`	`getAllPredecessorNodes()` Returns all predecessor `Node`s of this `Node`.
`java.util.Set<? extends Node>`	`getAllSuccessorNodes()` Returns all successor `Node`s of this `Node`.
`java.util.Map<java.lang.String,java.lang.Object>`	`getAttrs()` Returns the attributes map of this `Node` by reference.
`Graph`	`getGraph()` Returns the `Graph` to which this `Node` belongs.
`java.util.Set<Edge>`	`getLocalIncomingEdges()` Returns the local incoming `Edge`s of this `Node`.
`java.util.Set<Node>`	`getLocalNeighbors()` Returns all (local) neighbors of this `Node`, i.e. the union of the `getLocalPredecessorNodes()` and `getLocalSuccessorNodes()` .
`java.util.Set<Edge>`	`getLocalOutgoingEdges()` Returns the local outgoing `Edge`s of this `Node`.
`java.util.Set<Node>`	`getLocalPredecessorNodes()` Returns the local predecessor `Node`s of this `Node`.
`java.util.Set<Node>`	`getLocalSuccessorNodes()` Returns the local successor `Node`s of this `Node`.
`Graph`	`getNestedGraph()` Returns the `Graph` that is nested inside of this `Node`.
`int`	`hashCode()`
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`setGraph(Graph graph)` Sets the `Graph` to which this `Node` belongs to the given value.
`void`	`setNestedGraph(Graph nestedGraph)` Sets the `Graph` which is nested inside this `Node` to the given value.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ATTRIBUTES_PROPERTY
```
public static final java.lang.String ATTRIBUTES_PROPERTY
```
    The property name that is used to notify change listeners about changes made to the attributes of this Node. A property change event for this property will have its old value set to a Map<String, Object> holding the old attributes and its new value set to a Map<String, Object> holding the new attributes.
    
    See Also:
    
    Constant Field Values
  - pcs
```
protected java.beans.PropertyChangeSupport pcs
```
    The PropertyChangeSupport which handles (un-)registration of PropertyChangeListeners and firing of PropertyChangeEvent s.
- Constructor Detail
  - Node
```
public Node()
```
    Constructs a new Node.
  - Node
```
public Node(java.util.Map<java.lang.String,java.lang.Object> attrs)
```
    Constructs a new Node and copies the given attributes into the attributes map of this Node.
    
    Parameters:
    
    attrs - A Map containing the attributes which are copied into the attributes map of this Node.
- Method Detail
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Specified by:
    
    addPropertyChangeListener in interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier
  - equals
```
public boolean equals(java.lang.Object that)
```
    Overrides:
    
    equals in class java.lang.Object
  - getAllIncomingEdges
```
public java.util.Set<? extends Edge> getAllIncomingEdges()
```
    Returns all incoming Edges of this Node. The full graph hierarchy is scanned for incoming edges, and not just the associated graph.
    
    Returns:
    
    All incoming Edges.
  - getAllNeighbors
```
public java.util.Set<Node> getAllNeighbors()
```
    Returns all neighbors of this Node. The full graph hierarchy is scanned for neighbors, and not just the associated graph.
    
    Returns:
    
    All neighbors.
  - getAllOutgoingEdges
```
public java.util.Set<? extends Edge> getAllOutgoingEdges()
```
    Returns all outgoing Edges of this Node. The full graph hierarchy is scanned for outgoing edges, and not just the associated graph.
    
    Returns:
    
    All outgoing Edges.
  - getAllPredecessorNodes
```
public java.util.Set<? extends Node> getAllPredecessorNodes()
```
    Returns all predecessor Nodes of this Node. The full graph hierarchy is scanned for predecessor nodes, and not just the associated graph.
    
    Returns:
    
    All predecessor Nodes.
  - getAllSuccessorNodes
```
public java.util.Set<? extends Node> getAllSuccessorNodes()
```
    Returns all successor Nodes of this Node. The full graph hierarchy is scanned for successor nodes, and not just the associated graph.
    
    Returns:
    
    All successor Nodes.
  - getAttrs
```
public java.util.Map<java.lang.String,java.lang.Object> getAttrs()
```
    Returns the attributes map of this Node by reference. When this map is changed, a PropertyChangeEvent is fired for the ATTRIBUTES_PROPERTY.
    
    Returns:
    
    The attributes map of this Node by reference.
  - getGraph
```
public Graph getGraph()
```
    Returns the Graph to which this Node belongs.
    
    Returns:
    
    The Graph to which this Node belongs.
  - getLocalIncomingEdges
```
public java.util.Set<Edge> getLocalIncomingEdges()
```
    Returns the local incoming Edges of this Node. Only the associated graph is scanned for incoming edges, and not the whole graph hierarchy.
    
    Returns:
    
    The local incoming Edges.
  - getLocalNeighbors
```
public java.util.Set<Node> getLocalNeighbors()
```
    Returns all (local) neighbors of this Node, i.e. the union of the getLocalPredecessorNodes() and getLocalSuccessorNodes() .
    
    Returns:
    
    All (local) neighbors of this Node.
  - getLocalOutgoingEdges
```
public java.util.Set<Edge> getLocalOutgoingEdges()
```
    Returns the local outgoing Edges of this Node. Only the associated graph is scanned for outgoing edges, and not the whole graph hierarchy.
    
    Returns:
    
    The local outgoing Edges.
  - getLocalPredecessorNodes
```
public java.util.Set<Node> getLocalPredecessorNodes()
```
    Returns the local predecessor Nodes of this Node. Only the associated graph is scanned for predecessor nodes, and not the whole graph hierarchy.
    
    Returns:
    
    The local predecessor Nodes.
  - getLocalSuccessorNodes
```
public java.util.Set<Node> getLocalSuccessorNodes()
```
    Returns the local successor Nodes of this Node. Only the associated graph is scanned for successor nodes, and not the whole graph hierarchy.
    
    Returns:
    
    The local successor Nodes.
  - getNestedGraph
```
public Graph getNestedGraph()
```
    Returns the Graph that is nested inside of this Node. May be null.
    
    Returns:
    
    The Graph that is nested inside of this Node, or null.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Specified by:
    
    removePropertyChangeListener in interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier
  - setGraph
```
public void setGraph(Graph graph)
```
    Sets the Graph to which this Node belongs to the given value.
    
    Parameters:
    
    graph - The new Graph for this Node.
  - setNestedGraph
```
public void setNestedGraph(Graph nestedGraph)
```
    Sets the Graph which is nested inside this Node to the given value.
    
    Parameters:
    
    nestedGraph - The new nested Graph for this Node.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Node

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTRIBUTES_PROPERTY

pcs

Constructor Detail

Node

Node

Method Detail

addPropertyChangeListener

equals

getAllIncomingEdges

getAllNeighbors

getAllOutgoingEdges

getAllPredecessorNodes

getAllSuccessorNodes

getAttrs

getGraph

getLocalIncomingEdges

getLocalNeighbors

getLocalOutgoingEdges

getLocalPredecessorNodes

getLocalSuccessorNodes

getNestedGraph

hashCode

removePropertyChangeListener

setGraph

setNestedGraph

toString