salvo.jesus.graph

Interface DirectedGraph

All Superinterfaces:

Graph, Serializable

All Known Subinterfaces:

DirectedAcyclicGraph

All Known Implementing Classes:

DirectedAcyclicGraphAdaptor, DirectedAcyclicGraphImpl, DirectedGraphDelegator, DirectedGraphImpl

public interface DirectedGraph
extends Graph

A directed Graph where edges have a specified direction. Edges in this graph are therefore instances of DirectedEdge.

Author:

Jesus M. Salvo Jr.

Method Summary

Modifier and Type	Method and Description
DirectedEdge	getEdge(Vertex fromvertex, Vertex tovertex) Returns an Edge in the Graph whose origin is fromVertex and destination is toVertex.
List	getIncomingAdjacentVertices(Vertex v) Returns the vertices that are adjacent to a specified Vertex where the Edge is incoming from the specified Vertex to the adjacent vertex.
List	getIncomingEdges(Vertex v) Returns the incoming edges of a particular Vertex in the Graph.
List	getOutgoingAdjacentVertices(Vertex v) Returns the vertices that are adjacent to a specified Vertex where the Edge is outgoing from the specified Vertex to the adjacent vertex.
List	getOutgoingEdges(Vertex v) Returns the outgoing edges of a particular Vertex in the Graph.
boolean	isCycle(Vertex fromVertex) Determines if there is a cycle from Vertex fromVertex.
boolean	isPath(Vertex fromVertex, Vertex toVertex) Determines if there is a path from Vertex fromVertex to Vertex toVertex.

Methods inherited from interface salvo.jesus.graph.Graph

add, addEdge, addEdge, addGraphAddEdgeListener, addGraphAddVertexListener, addGraphRemoveEdgeListener, addGraphRemoveVertexListener, addListener, cloneVertices, getAdjacentVertices, getAdjacentVertices, getConnectedSet, getConnectedSet, getDegree, getDegree, getEdges, getEdgesCount, getEdgeSet, getGraphFactory, getTraversal, getVertexSet, getVertices, getVerticesCount, getVerticesIterator, isConnected, remove, removeEdge, removeEdges, removeGraphAddEdgeListener, removeGraphAddVertexListener, removeGraphRemoveEdgeListener, removeGraphRemoveVertexListener, removeListener, setGraphFactory, setTraversal, traverse

Method Detail

getOutgoingEdges

List getOutgoingEdges(Vertex v)

Returns the outgoing edges of a particular Vertex in the Graph.

Parameters:

v - Vertex you want to determine its outgoing edges.

Returns:

List of outgoing edges of the specified Vertex.

getIncomingEdges

List getIncomingEdges(Vertex v)

Returns the incoming edges of a particular Vertex in the Graph.

Parameters:

v - Vertex you want to determine its incoming edges.

Returns:

List of incoming edges of the specified Vertex.

getOutgoingAdjacentVertices

List getOutgoingAdjacentVertices(Vertex v)

Returns the vertices that are adjacent to a specified Vertex where the Edge is outgoing from the specified Vertex to the adjacent vertex.

Parameters:

v - Vertex you want to determine its outgoing adjacent vertices.

Returns:

List of outgoing vertices adjacent to the specified Vertex.

getIncomingAdjacentVertices

List getIncomingAdjacentVertices(Vertex v)

Returns the vertices that are adjacent to a specified Vertex where the Edge is incoming from the specified Vertex to the adjacent vertex.

Parameters:

v - Vertex you want to determine its incoming adjacent vertices.

Returns:

List of incoming vertices adjacent to the specified Vertex.

getEdge

DirectedEdge getEdge(Vertex fromvertex,
                     Vertex tovertex)

Returns an Edge in the Graph whose origin is fromVertex and destination is toVertex. If there is more than one Edge that has the same origin and destination in the Graph, the first matching Edge is returned.

Parameters:

fromVertex - Vertex that is the origin of the directed Edge

toVertex - Vertex that is the destination of the directed Edge

Returns:

Edge whose origin is fromVertex and destination is toVertex

See Also:

Edge

isPath

boolean isPath(Vertex fromVertex,
               Vertex toVertex)

Determines if there is a path from Vertex fromVertex to Vertex toVertex. This will not return true if the only path has at least one Edge pointing in the opposite direction of the path.

Parameters:

fromVertex - starting Vertex for the path

toVertex - ending Vertex for the path

Returns:

true if there is a path from Vertex to toVertex. false otherwise.

isCycle

boolean isCycle(Vertex fromVertex)

Determines if there is a cycle from Vertex fromVertex. A cycle occurs when there is a path from the specified Vertex back to itself, taking into consideration that direction of the Edges along the path. This simply calls isPath(), where both parameters are the same Vertex.

Parameters:

fromVertex - Vertex to be tested for a cycle path.

Returns:

true if there is a cycle path from fromVertex to itself.