01: /*
02: * GeoTools - OpenSource mapping toolkit
03: * http://geotools.org
04: * (C) 2002-2006, GeoTools Project Managment Committee (PMC)
05: * (C) 2002, Refractions Reserach Inc.
06: *
07: * This library is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU Lesser General Public
09: * License as published by the Free Software Foundation;
10: * version 2.1 of the License.
11: *
12: * This library is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: */
17: package org.geotools.graph.structure;
18:
19: /**
20: * Represents an edge in a directed graph. A directed edge catagorizes its
21: * nodes as originating (in node), and terminating (out node). The edge is an
22: * <B>out edge</B> of its <B>in node</B> and an <B>in edge</B> to its <B>out
23: * node</B>.
24: *
25: * @see DirectedGraph
26: * @author Justin Deoliveira, Refractions Research Inc, jdeolive@refractions.net
27: *
28: * @source $URL: http://svn.geotools.org/geotools/tags/2.4.1/modules/extension/graph/src/main/java/org/geotools/graph/structure/DirectedEdge.java $
29: */
30: public interface DirectedEdge extends Edge, DirectedGraphable {
31:
32: /**
33: * Returns the originating (in) node of the edge.
34: *
35: * @return The directed node at the source of the edge.
36: */
37: public DirectedNode getInNode();
38:
39: /**
40: * Returns the terminating (out) node of the edge.
41: *
42: * @return The directed node at the destination of the edge.
43: */
44: public DirectedNode getOutNode();
45:
46: }
|