prajna.util

Class DirectedGraph<N,E>

java.lang.Object

prajna.util.AbstractGraph<N,E>

prajna.util.DirectedGraph<N,E>

Type Parameters:

N - The class representing the nodes of the graph

E - The class representing the edges of the graph

All Implemented Interfaces:

java.io.Serializable, Graph<N,E>

Direct Known Subclasses:

TimedGraph, TreeGraph

public class DirectedGraph<N,E>
extends AbstractGraph<N,E>

Implementation of a Directed Graph.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DirectedGraph() Instantiates a new empty directed graph.
DirectedGraph(Graph<? extends N,? extends E> graph) Instantiates a new directed graph, with node and edge data copied from the given graph.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(N node) Add a node to the graph.
boolean	addEdge(E edge, N orig, N dest) Add the edge element to the graph.
E	getEdge(N n1, N n2) Get the edge between two nodes.
prajna.util.DirectedGraph.Segment<N,E>	getEdgeSegment(E edge) Get the edge segment for the specified edge.
java.util.Set<E>	getEdgeSet() Get the set of edges for this graph.
java.util.Set<N>	getNodeSet() Get the set of nodes for this graph.
java.util.Set<Graph.Segment<N,E>>	getSegmentSet() Get the set of edge segments for this graph.
boolean	isDirected() Returns whether this graph is directed
java.lang.String	toString() Return a string representation of this graph

Methods inherited from class prajna.util.AbstractGraph

addAll, clear, contains, containsEdge, edgeIterator, equals, getNodeEdges, hashCode, isEmpty, iterator, order, remove, removeEdge, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DirectedGraph

public DirectedGraph()

Instantiates a new empty directed graph.

DirectedGraph

public DirectedGraph(Graph<? extends N,? extends E> graph)

Instantiates a new directed graph, with node and edge data copied from the given graph.

Parameters:

graph - the graph to copy

Method Detail

add

public boolean add(N node)

Add a node to the graph.

Parameters:

node - the node to add

Returns:

true if the node was not already in the graph, false otherwise

addEdge

public boolean addEdge(E edge,
              N orig,
              N dest)

Add the edge element to the graph. If the origin or destination nodes are not included in the graph, they are also added.

Parameters:

edge - the edge to add

orig - the origin node

dest - the destination node

Returns:

true if the graph was modified as a result of this operation, false otherwise.

getEdge

public E getEdge(N n1,
        N n2)

Get the edge between two nodes.

Parameters:

n1 - The first node

n2 - The second node

Returns:

the edge between the two nodes, or null if no edge exists.

getEdgeSegment

public prajna.util.DirectedGraph.Segment<N,E> getEdgeSegment(E edge)

Get the edge segment for the specified edge.

Parameters:

edge - the edge

Returns:

the segment containing the edge.

getEdgeSet

public java.util.Set<E> getEdgeSet()

Get the set of edges for this graph.

Returns:

the set of edges

getNodeSet

public java.util.Set<N> getNodeSet()

Get the set of nodes for this graph.

Returns:

the set of nodes

getSegmentSet

public java.util.Set<Graph.Segment<N,E>> getSegmentSet()

Get the set of edge segments for this graph.

Returns:

the set of edge segments

isDirected

public boolean isDirected()

Returns whether this graph is directed

Specified by:

isDirected in interface Graph<N,E>

Specified by:

isDirected in class AbstractGraph<N,E>

Returns:

true

toString

public java.lang.String toString()

Return a string representation of this graph

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this graph