org.geotools.graph.structure
Interface DirectedEdge

All Superinterfaces:
DirectedGraphable, Edge, Graphable
All Known Implementing Classes:
BasicDirectedEdge, OptDirectedEdge

public interface DirectedEdge
extends Edge, DirectedGraphable

Represents an edge in a directed graph. A directed edge catagorizes its nodes as originating (in node), and terminating (out node). The edge is an out edge of its in node and an in edge to its out node.

Author:
Justin Deoliveira, Refractions Research Inc, jdeolive@refractions.net
See Also:
DirectedGraph
Module:
modules/extension/graph (gt-graph.jar)

Field Summary
 
Fields inherited from interface Edge
EQUAL_NODE_ORIENTATION, OPPOSITE_NODE_ORIENTATION, UNEQUAL_NODE_ORIENTATION
 
Method Summary
 DirectedNode getInNode()
          Returns the originating (in) node of the edge.
 DirectedNode getOutNode()
          Returns the terminating (out) node of the edge.
 
Methods inherited from interface Edge
compareNodes, getNodeA, getNodeB, getOtherNode, reverse
 
Methods inherited from interface Graphable
getCount, getID, getObject, getRelated, isVisited, setCount, setID, setObject, setVisited
 
Methods inherited from interface DirectedGraphable
getInRelated, getOutRelated
 
Methods inherited from interface Graphable
getCount, getID, getObject, getRelated, isVisited, setCount, setID, setObject, setVisited
 

Method Detail

getInNode

DirectedNode getInNode()
Returns the originating (in) node of the edge.

Returns:
The directed node at the source of the edge.

getOutNode

DirectedNode getOutNode()
Returns the terminating (out) node of the edge.

Returns:
The directed node at the destination of the edge.


Copyright © 1996-2010 Geotools. All Rights Reserved.