Node

All Known Implementing Classes:

NodeWithLevel, NodeWrapper, StandardNode, SugiyamaDrawingAlgorithm.BarycenterNode, SugiyamaOriginalPositionCalculator.IntermediateNode
```
public interface Node
```
A single node in a graph.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addEdge(Edge edge)` Adds an edge to this node, if it doesn't exist yet.
`default double`	`distance(Node other)` Returns the distance between this and the other node.
`default double`	`distanceSquared(Node other)` Returns the squared distance between this and the other node.
`default java.util.Optional<Edge>`	`getEdgeForNeighbor(Node neighbor)` Gets the edge which points to the given neighbor, if it exists.
`java.util.Collection<Edge>`	`getEdges()` Returns all ingoing and outgoing edges of this node.
`default java.util.List<Edge>`	`getIncomingEdges()` Returns all edges which are incoming into this node.
`<T> java.util.Optional<T>`	`getMetaInformation(java.lang.Class<T> clazz)` Gets the meta information contained in this node if it exists.
`default java.util.List<Node>`	`getNeighbors()` Returns all neighbors of this node, i.e.
`java.util.Optional<Position>`	`getOldPosition()` Get the previous position of this node, if any exists.
`default java.util.List<Edge>`	`getOutgoingEdges()` Returns all edges which are outgoing from this node.
`Position`	`getPosition()` Get the current position of this node.
`default java.util.List<Node>`	`getPredecessors()` Returns all nodes which are predecessors of this node, i.e.
`default java.util.List<Node>`	`getSuccessors()` Returns all nodes which are successors of this node, i.e.
`java.lang.Object`	`getValue()` Returns the value stored in this node.
`default boolean`	`hasSuccessor(Node successor)` Returns whether the given node is a successor of this node.
`void`	`removeEdge(Edge edge)` Removes an edge from this node, if it exists.
`<T> void`	`setMetaInformation(T meta)` Set the meta information contained in this node.
`default void`	`setOldPosition()` Set the old position to the current position.
`void`	`setOldPosition(Position oldPosition)` Set the old position to the given position.
`void`	`setPosition(Position position)` Set the position of this node.
`void`	`setValue(java.lang.Object value)` Sets the value stored in this node.
`java.lang.String`	`toString()`

- Method Detail
  - getValue
```
java.lang.Object getValue()
```
    Returns the value stored in this node.
  - setValue
```
void setValue(java.lang.Object value)
```
    Sets the value stored in this node.
    
    Parameters:
    
    value - The new value.
  - addEdge
```
void addEdge(Edge edge)
```
    Adds an edge to this node, if it doesn't exist yet. Does nothing otherwise.
    
    Parameters:
    
    edge - The edge to add.
  - removeEdge
```
void removeEdge(Edge edge)
```
    Removes an edge from this node, if it exists. Does nothing otherwise.
    
    Parameters:
    
    edge - The edge to remove.
  - getEdges
```
java.util.Collection<Edge> getEdges()
```
    Returns all ingoing and outgoing edges of this node.
  - getSuccessors
```
default java.util.List<Node> getSuccessors()
```
    Returns all nodes which are successors of this node, i.e. which have an edge pointing from this node to the other node.
  - getPredecessors
```
default java.util.List<Node> getPredecessors()
```
    Returns all nodes which are predecessors of this node, i.e. which have this node as a successor.
  - getNeighbors
```
default java.util.List<Node> getNeighbors()
```
    Returns all neighbors of this node, i.e. its predecessors and successors.
  - hasSuccessor
```
default boolean hasSuccessor(Node successor)
```
    Returns whether the given node is a successor of this node.
    
    Parameters:
    
    successor - The node for which to check succession.
    
    Returns:
    
    Whether the other node is a successor of this node.
  - getOutgoingEdges
```
default java.util.List<Edge> getOutgoingEdges()
```
    Returns all edges which are outgoing from this node.
  - getIncomingEdges
```
default java.util.List<Edge> getIncomingEdges()
```
    Returns all edges which are incoming into this node.
  - getEdgeForNeighbor
```
default java.util.Optional<Edge> getEdgeForNeighbor(Node neighbor)
```
    Gets the edge which points to the given neighbor, if it exists.
    
    Parameters:
    
    neighbor - The possible neighbor.
    
    Returns:
    
    An edge pointing to the given neighbor, and an empty optional if none exists.
  - getOldPosition
```
java.util.Optional<Position> getOldPosition()
```
    Get the previous position of this node, if any exists. Otherwise an empty optional is returned.
  - setOldPosition
```
void setOldPosition(Position oldPosition)
```
    Set the old position to the given position.
    
    Parameters:
    
    oldPosition - The new old position.
  - setOldPosition
```
default void setOldPosition()
```
    Set the old position to the current position.
  - getPosition
```
Position getPosition()
```
    Get the current position of this node.
  - setPosition
```
void setPosition(Position position)
```
    Set the position of this node.
    
    Parameters:
    
    position - The new position.
  - distance
```
default double distance(Node other)
```
    Returns the distance between this and the other node.
    
    Parameters:
    
    other - The other node.
    
    Returns:
    
    The euclidean distance between this and the other node.
  - distanceSquared
```
default double distanceSquared(Node other)
```
    Returns the squared distance between this and the other node.
    
    Parameters:
    
    other - The other node.
    
    Returns:
    
    The squared euclidean distance between this and the other node.
  - setMetaInformation
```
<T> void setMetaInformation(T meta)
```
    Set the meta information contained in this node. The node may have one piece of meta information for each type. This method overwrites a possibly existing meta information object of the same type.
    
    Type Parameters:
    
    T - The type of the new piece of meta information.
    
    Parameters:
    
    meta - The new piece of meta information.
  - getMetaInformation
```
<T> java.util.Optional<T> getMetaInformation(java.lang.Class<T> clazz)
```
    Gets the meta information contained in this node if it exists.
    
    Type Parameters:
    
    T - The type of the meta information object.
    
    Parameters:
    
    clazz - The class of the meta information object.
    
    Returns:
    
    The meta information object for the given class, or an empty optional if none exists.
  - toString
```
java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Interface Node

Method Summary

Method Detail

getValue

setValue

addEdge

removeEdge

getEdges

getSuccessors

getPredecessors

getNeighbors

hasSuccessor

getOutgoingEdges

getIncomingEdges

getEdgeForNeighbor

getOldPosition

setOldPosition

setOldPosition

getPosition

setPosition

distance

distanceSquared

setMetaInformation

getMetaInformation

toString