org.graphstream.graph
Interface Edge

All Superinterfaces:
Element
All Known Implementing Classes:
AbstractEdge, GraphicEdge

public interface Edge
extends Element

A general purpose class that provides methods for the management of edges in a graph.

Important

Implementing classes may indicate the complexity of their implementation of the methods with the complexity tag.

Since:
July 12 2007

Method Summary
<T extends Node>
T
getNode0()
          First node of the edge.
<T extends Node>
T
getNode1()
          Second node of the edge.
<T extends Node>
T
getOpposite(Node node)
          When knowing one node and one edge of this node, this method return the node at the other end of the edge.
<T extends Node>
T
getSourceNode()
          Start node.
<T extends Node>
T
getTargetNode()
          End node.
 boolean isDirected()
          Is the edge directed ?.
 boolean isLoop()
          Does the source and target of this edge identify the same node ?.
 
Methods inherited from interface org.graphstream.graph.Element
addAttribute, addAttributes, changeAttribute, clearAttributes, getArray, getAttribute, getAttribute, getAttributeCount, getAttributeKeyIterator, getAttributeKeySet, getFirstAttributeOf, getFirstAttributeOf, getHash, getId, getIndex, getLabel, getNumber, getVector, hasArray, hasAttribute, hasAttribute, hasHash, hasLabel, hasNumber, hasVector, removeAttribute, setAttribute
 

Method Detail

isDirected

boolean isDirected()
Is the edge directed ?.

Returns:
True if the edge is directed.

isLoop

boolean isLoop()
Does the source and target of this edge identify the same node ?.

Returns:
True if this edge is a loop.

getNode0

<T extends Node> T getNode0()
First node of the edge.

This is equivalent to the getSourceNode() method, but may be clearer in the source code if the graph you are using is not directed.

This method is implicitly generic and return something which extends Node. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedNode n = edge.getNode0();
 
the method will return an ExtendedNode. If no left part exists, method will just return a Node.

Returns:
The first node of the edge.
See Also:
getNode1(), getSourceNode()

getNode1

<T extends Node> T getNode1()
Second node of the edge.

This is equivalent to the getTargetNode() method, but may be clearer in the source code if the graph you are using is not directed.

This method is implicitly generic and return something which extends Node. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedNode n = edge.getNode1();
 
the method will return an ExtendedNode. If no left part exists, method will just return a Node.

Returns:
The second node of the edge.
See Also:
getNode0(), getTargetNode()

getSourceNode

<T extends Node> T getSourceNode()
Start node.

When the edge is directed this is the source node, in this case you can get the opposite node using getTargetNode(). This is equivalent to the getNode0() method but may be clearer in the source code if the graph you are using is directed.

This method is implicitly generic and return something which extends Node. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedNode n = edge.getSourceNode();
 
the method will return an ExtendedNode. If no left part exists, method will just return a Node.

Returns:
The origin node of the edge.
See Also:
getNode0(), getTargetNode()

getTargetNode

<T extends Node> T getTargetNode()
End node.

When the edge is directed this is the target node, in this case you can get the opposite node using getSourceNode(). This is equivalent to the getNode1() method but may be clearer in the source code if the graph you are using is directed.

This method is implicitly generic and return something which extends Node. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedNode n = edge.getTargetNode();
 
the method will return an ExtendedNode. If no left part exists, method will just return a Node.

Returns:
The destination node of the edge.
See Also:
getNode1(), getSourceNode()

getOpposite

<T extends Node> T getOpposite(Node node)
When knowing one node and one edge of this node, this method return the node at the other end of the edge.

Return null if the given node is not at any end of the edge.

This method is implicitly generic and return something which extends Node. The return type is the one of the left part of the assignment. For example, in the following call :

 ExtendedNode n = edge.getOppositeNode((ExtendedNode) m);
 
the method will return an ExtendedNode. If no left part exists, method will just return a Node.

Parameters:
node - The node we search the opposite of.
Returns:
the opposite node of the given node.


Copyright © 2012. All Rights Reserved.