org.apache.commons.graph
Interface Path

All Known Subinterfaces:
WeightedPath
All Known Implementing Classes:
AllPairsShortestPath.WPath, PathImpl

public interface Path

Description of the Interface


Method Summary
 java.util.List getEdges()
          getEdges() - This returns a list of Edges which comprise the path.
 Vertex getEnd()
          Returns the end of the path.
 Vertex getStart()
          Returns the start of the path.
 java.util.List getVertices()
          getVertices() - This returns a list of Vertices, in order as they go from Start to End.
 int size()
          size() - This returns the size of the path in terms of number of verticies it visits.
 

Method Detail

getStart

public Vertex getStart()
Returns the start of the path.


getEnd

public Vertex getEnd()
Returns the end of the path.


getVertices

public java.util.List getVertices()
getVertices() - This returns a list of Vertices, in order as they go from Start to End. This includes the Start and End vertex, and will have one more entry than the Edges list.


getEdges

public java.util.List getEdges()
getEdges() - This returns a list of Edges which comprise the path. It will have one less than the list of Vertices.


size

public int size()
size() - This returns the size of the path in terms of number of verticies it visits.