Node (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.algorithms.GraphObject
- - com.yworks.yfiles.algorithms.Node

```
public class Node
extends GraphObject
```
Represents a so-called node in the directed graph data type Graph.
Most notably, a node provides access to its adjacent edges (represented by instances of class Edge). These can be distinguished into the sets of incoming and outgoing edges.

Iteration over all three sets of edges is provided by means of bidirectional cursors that present a read-only view of the respective set (getEdgeCursor(), getInEdgeCursor(Edge), getOutEdgeCursor(Edge)). Also supported is iteration over all nodes at opposite ends of either incoming edges or outgoing edges (getPredecessorCursor(), getSuccessorCursor()).

The number of overall edges at a node is called its degree (Degree), which is the sum of incoming and outgoing edges (InDegree, OutDegree).

Important: Class Graph is the single authority for any structural changes to the graph data type. Specifically, this means that there is no way to create or delete a node or an edge without using an actual Graph instance.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Node(Graph g)
Instantiates a new Node object that will be part of the given graph.

Constructors
Modifier	Constructor and Description
`protected`	`Node(Graph g)` Instantiates a new Node object that will be part of the given graph.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Node`	`createCopy(Graph g)` Creates a copy of this node that will be inserted into the given graph.
`int`	`degree()` Gets the overall number of incoming and outgoing edges at this node.
`Edge`	`firstInEdge()` Gets the first incoming edge at this node, or `null` if it does not exist.
`Edge`	`firstOutEdge()` Gets the first outgoing edge at this node, or `null` if it does not exist.
`Edge`	`getEdge(Node opposite)` Returns an edge that connects this node with the given node, if such an edge exists.
`IEdgeCursor`	`getEdgeCursor()` Returns an edge cursor for all incoming and outgoing edges at this node.
`Edge`	`getEdgeFrom(Node source)` Returns an incoming edge that connects the given node with this node, if such an edge exists.
`IEnumerable<Edge>`	`getEdges()` Yields a dynamic `Iterable` for `Edge`s that can be used to iterate over the adjacent edges at this instance.
`Edge`	`getEdgeTo(Node target)` Returns an outgoing edge that connects this node with the given node, if such an edge exists.
`Graph`	`getGraph()` Gets the graph this node belongs to.
`IEdgeCursor`	`getInEdgeCursor()` Returns an edge cursor for incoming edges at this node.
`IEdgeCursor`	`getInEdgeCursor(Edge startEdge)` Returns an edge cursor for incoming edges at this node.
`IEnumerable<Edge>`	`getInEdges()` Yields a dynamic `Iterable` for `Edge`s that can be used to iterate over ingoing edges at this instance.
`INodeCursor`	`getNeighborCursor()` Returns a node cursor for all neighbor nodes of this node.
`IEnumerable<Node>`	`getNeighbors()` Yields a dynamic `Iterable` for `Node`s that can be used to iterate over the opposite sides of adjacent adjacent edges at this instance.
`IEdgeCursor`	`getOutEdgeCursor()` Returns an edge cursor for outgoing edges at this node.
`IEdgeCursor`	`getOutEdgeCursor(Edge startEdge)` Returns an edge cursor for outgoing edges at this node.
`IEnumerable<Edge>`	`getOutEdges()` Yields a dynamic `Iterable` for `Edge`s that can be used to iterate over outgoing edges at this instance.
`INodeCursor`	`getPredecessorCursor()` Returns a node cursor for all predecessor nodes of this node.
`IEnumerable<Node>`	`getPredecessors()` Yields a dynamic `Iterable` for `Node`s that can be used to iterate over the opposite sides of adjacent incoming edges at this instance.
`INodeCursor`	`getSuccessorCursor()` Returns a node cursor for all successor nodes of this node.
`IEnumerable<Node>`	`getSuccessors()` Yields a dynamic `Iterable` for `Node`s that can be used to iterate over the opposite sides of adjacent outgoing edges at this instance.
`int`	`inDegree()` Gets the number of incoming edges at this node.
`int`	`index()` Gets the index of this node within its graph G.
`Edge`	`lastInEdge()` Gets the last incoming edge at this node, or `null` if it does not exist.
`Edge`	`lastOutEdge()` Gets the last outgoing edge at this node, or `null` if it does not exist.
`int`	`outDegree()` Gets the number of outgoing edges at this node.
`void`	`sortInEdges(Comparator<Object> c)` Sorts incoming edges at this node according to the given comparator.
`void`	`sortOutEdges(Comparator<Object> c)` Sorts outgoing edges at this node according to the given comparator.
`String`	`toString()` Returns a String representation of this node.

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

- Constructor Detail
  - Node
```
protected Node(Graph g)
```
    Instantiates a new Node object that will be part of the given graph.
    
    Parameters:
    
    g - The graph that the created node will belong to.
- Method Detail
  - createCopy
```
public Node createCopy(Graph g)
```
    Creates a copy of this node that will be inserted into the given graph.
    
    Parameters:
    
    g - The graph that the created node will belong to.
    
    Returns:
    
    The newly created Node object.
  - degree
```
public final int degree()
```
    Gets the overall number of incoming and outgoing edges at this node.
    Note that self-loops are counted twice.
    
    Returns:
    
    The Degree.
    
    See Also:
    
    Edge, inDegree(), outDegree()
  - firstInEdge
```
public final Edge firstInEdge()
```
    Gets the first incoming edge at this node, or null if it does not exist.
    
    Returns:
    
    The FirstInEdge.
    
    See Also:
    
    firstOutEdge(), lastInEdge()
  - firstOutEdge
```
public final Edge firstOutEdge()
```
    Gets the first outgoing edge at this node, or null if it does not exist.
    
    Returns:
    
    The FirstOutEdge.
    
    See Also:
    
    firstInEdge(), lastOutEdge()
  - getEdge
```
public final Edge getEdge(Node opposite)
```
    Returns an edge that connects this node with the given node, if such an edge exists.
    Otherwise null is returned.
    
    Note that the first matching edge is returned, and that outgoing edges are tested prior to incoming edges.
    
    See Also:
    
    getEdgeFrom(Node), getEdgeTo(Node)
  - getEdgeCursor
```
public final IEdgeCursor getEdgeCursor()
```
    Returns an edge cursor for all incoming and outgoing edges at this node.
    
    See Also:
    
    getInEdgeCursor(Edge), getOutEdgeCursor(Edge)
  - getEdgeFrom
```
public final Edge getEdgeFrom(Node source)
```
    Returns an incoming edge that connects the given node with this node, if such an edge exists.
    Otherwise null is returned.
    
    See Also:
    
    getEdge(Node), getEdgeTo(Node)
  - getEdges
```
public IEnumerable<Edge> getEdges()
```
    Yields a dynamic Iterable for Edges that can be used to iterate over the adjacent edges at this instance.
    This is a live enumerable and will thus reflect the current state of the node's adjacency. Note that changes to the graph structure during the traversal should be carried out with great care. Note that self-loop edges are reported twice (as in edge and as out edge).
    
    Returns:
    
    The Edges.
  - getEdgeTo
```
public final Edge getEdgeTo(Node target)
```
    Returns an outgoing edge that connects this node with the given node, if such an edge exists.
    Otherwise null is returned.
    
    See Also:
    
    getEdge(Node), getEdgeFrom(Node)
  - getGraph
```
public final Graph getGraph()
```
    Gets the graph this node belongs to.
    If the node does not belong to a graph, because it was removed or hidden from it, this method returns null.
    
    Returns:
    
    The Graph.
  - getInEdgeCursor
```
public final IEdgeCursor getInEdgeCursor()
```
    Returns an edge cursor for incoming edges at this node.
    If an edge is specified, the cursor starts at the given edge, and the cyclic sequence order is the same as returned by getInEdgeCursor(Edge).
    
    Precondition:
    startEdge is an incoming edge at this node.
    
    See Also:
    
    getOutEdgeCursor(Edge)
  - getInEdgeCursor
```
public final IEdgeCursor getInEdgeCursor(Edge startEdge)
```
    Returns an edge cursor for incoming edges at this node.
    If an edge is specified, the cursor starts at the given edge, and the cyclic sequence order is the same as returned by getInEdgeCursor(Edge).
    
    Precondition:
    startEdge is an incoming edge at this node.
    
    Parameters:
    
    startEdge - The first edge being accessed by the returned cursor.
    
    See Also:
    
    getOutEdgeCursor(Edge)
  - getInEdges
```
public IEnumerable<Edge> getInEdges()
```
    Yields a dynamic Iterable for Edges that can be used to iterate over ingoing edges at this instance.
    This is a live enumerable and will thus reflect the current state of the node's adjacency. Note that changes to the graph structure during the traversal should be carried out with great care. Note that self-loop edges are reported, too.
    
    Returns:
    
    The InEdges.
  - getNeighborCursor
```
public final INodeCursor getNeighborCursor()
```
    Returns a node cursor for all neighbor nodes of this node.
    Neighbor nodes are those at the opposite ends of both incoming and outgoing edges.
    
    See Also:
    
    getPredecessorCursor(), getSuccessorCursor()
  - getNeighbors
```
public IEnumerable<Node> getNeighbors()
```
    Yields a dynamic Iterable for Nodes that can be used to iterate over the opposite sides of adjacent adjacent edges at this instance.
    This is a live enumerable and will thus reflect the current state of the node's adjacency. Note that changes to the graph structure during the traversal should be carried out with great care. Note that for self-loop edges this node itself will be reported as a neighbor, twice.
    
    Returns:
    
    The Neighbors.
  - getOutEdgeCursor
```
public final IEdgeCursor getOutEdgeCursor()
```
    Returns an edge cursor for outgoing edges at this node.
    If an edge is specified, the cursor starts at the given edge, and the cyclic sequence order is the same as returned by getOutEdgeCursor(Edge).
    
    Precondition:
    startEdge is an outgoing edge at this node.
    
    See Also:
    
    getInEdgeCursor(Edge)
  - getOutEdgeCursor
```
public final IEdgeCursor getOutEdgeCursor(Edge startEdge)
```
    Returns an edge cursor for outgoing edges at this node.
    If an edge is specified, the cursor starts at the given edge, and the cyclic sequence order is the same as returned by getOutEdgeCursor(Edge).
    
    Precondition:
    startEdge is an outgoing edge at this node.
    
    Parameters:
    
    startEdge - The first edge being accessed by the returned cursor.
    
    See Also:
    
    getInEdgeCursor(Edge)
  - getOutEdges
```
public IEnumerable<Edge> getOutEdges()
```
    Yields a dynamic Iterable for Edges that can be used to iterate over outgoing edges at this instance.
    This is a live enumerable and will thus reflect the current state of the node's adjacency. Note that changes to the graph structure during the traversal should be carried out with great care. Note that self-loop edges are reported, too.
    
    Returns:
    
    The OutEdges.
  - getPredecessorCursor
```
public final INodeCursor getPredecessorCursor()
```
    Returns a node cursor for all predecessor nodes of this node.
    Predecessor nodes are those at the opposite ends of incoming edges.
    
    See Also:
    
    getSuccessorCursor()
  - getPredecessors
```
public IEnumerable<Node> getPredecessors()
```
    Yields a dynamic Iterable for Nodes that can be used to iterate over the opposite sides of adjacent incoming edges at this instance.
    This is a live enumerable and will thus reflect the current state of the node's adjacency. Note that changes to the graph structure during the traversal should be carried out with great care. Note that for self-loop edges this node itself will be reported as a predecessor.
    
    Returns:
    
    The Predecessors.
  - getSuccessorCursor
```
public final INodeCursor getSuccessorCursor()
```
    Returns a node cursor for all successor nodes of this node.
    Successor nodes are those at the opposite ends of outgoing edges.
    
    See Also:
    
    getPredecessorCursor()
  - getSuccessors
```
public IEnumerable<Node> getSuccessors()
```
    Yields a dynamic Iterable for Nodes that can be used to iterate over the opposite sides of adjacent outgoing edges at this instance.
    This is a live enumerable and will thus reflect the current state of the node's adjacency. Note that changes to the graph structure during the traversal should be carried out with great care. Note that for self-loop edges this node itself will be reported as a successor.
    
    Returns:
    
    The Successors.
  - inDegree
```
public final int inDegree()
```
    Gets the number of incoming edges at this node.
    
    Returns:
    
    The InDegree.
    
    See Also:
    
    degree(), outDegree()
  - index
```
public final int index()
```
    Gets the index of this node within its graph G.
    Node indices represent the ordering of standard node iteration on G. The value of an index is >= 0 and < G.nodeCount().
    
    Note that indices are subject to change whenever the sequence of nodes in a graph is modified by either removing, hiding, reinserting, or unhiding a node, or by explicitly changing its position in the sequence.
    
    Precondition:
    This node must belong to some graph.
    
    Returns:
    
    The Index.
    
    See Also:
    
    Graph.removeNode(Node), Graph.hide(Node), Graph.reInsertNode(Node), Graph.unhide(Node), Graph.moveToFirst(Node), Graph.moveToLast(Node)
  - lastInEdge
```
public final Edge lastInEdge()
```
    Gets the last incoming edge at this node, or null if it does not exist.
    
    Returns:
    
    The LastInEdge.
    
    See Also:
    
    firstInEdge(), lastOutEdge()
  - lastOutEdge
```
public final Edge lastOutEdge()
```
    Gets the last outgoing edge at this node, or null if it does not exist.
    
    Returns:
    
    The LastOutEdge.
    
    See Also:
    
    firstOutEdge(), lastInEdge()
  - outDegree
```
public final int outDegree()
```
    Gets the number of outgoing edges at this node.
    
    Returns:
    
    The OutDegree.
    
    See Also:
    
    degree(), inDegree()
  - sortInEdges
```
public final void sortInEdges(Comparator<Object> c)
```
    Sorts incoming edges at this node according to the given comparator.
    
    See Also:
    
    sortOutEdges(Comparator)
  - sortOutEdges
```
public final void sortOutEdges(Comparator<Object> c)
```
    Sorts outgoing edges at this node according to the given comparator.
    
    See Also:
    
    sortInEdges(Comparator)
  - toString
```
public String toString()
```
    Returns a String representation of this node.
    
    Overrides:
    
    toString in class Object

Class Node

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Node

Method Detail

createCopy

degree

firstInEdge

firstOutEdge

getEdge

getEdgeCursor

getEdgeFrom

getEdges

getEdgeTo

getGraph

getInEdgeCursor

getInEdgeCursor

getInEdges

getNeighborCursor

getNeighbors

getOutEdgeCursor

getOutEdgeCursor

getOutEdges

getPredecessorCursor

getPredecessors

getSuccessorCursor

getSuccessors

inDegree

index

lastInEdge

lastOutEdge

outDegree

sortInEdges

sortOutEdges

toString