org.wamblee.system.graph

Class Graph

java.lang.Object

org.wamblee.system.graph.Graph

Direct Known Subclasses:

ComponentGraph

public class Graph
extends Object

Represents a graph consisting of nodes and edges.

Author:

Erik Brakkee

Constructor Summary

Constructors

Constructor and Description
Graph() Constructs the graph.

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor aVisitor) Implements a visitor design pattern.
void	addEdge(Edge aEdge) Adds an edge.
void	addEdges(List<Edge> aEdges) Adds a number of edges.
void	addNode(Node aNode) Adds a node.
void	addNodes(List<Node> aNodes) Adds a list of nodes.
void	applyFilter(EdgeFilter aFilter) Applies a filter to the graph for removing elements.
void	extend(EdgeFactory aFactory) Extends the graph with edges using an edge factory.
List<Edge>	findIncoming(Node aNode) Finds all incoming edges of a node.
Node	findNode(String aName) Finds a node with the given name.
List<Edge>	findOutgoing(Node aNode) Finds all outgoing edges of a node.
List<Edge>	getEdges() Gets the edges.
List<Node>	getNodes() Gets the nodes.
boolean	removeEdge(Edge aEdge) Removes an edge.
boolean	removeNode(Node aNode) Removes a node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Graph

public Graph()

Constructs the graph.

Method Detail

addNode

public void addNode(Node aNode)

Adds a node.

Parameters:

aNode - Node to add.

Throws:

IllegalArgumentException - In case the node already exists. Node equality is checked using equals.

findNode

public Node findNode(String aName)

Finds a node with the given name.

Parameters:

aName - Node name.

Returns:

Node or null if not found.

removeNode

public boolean removeNode(Node aNode)

Removes a node.

Parameters:

aNode - Node to remove.

Returns:

True iff the node was removed.

Throws:

IllegalArgumentException - In case there are edges of which the node is a part.

addNodes

public void addNodes(List<Node> aNodes)

Adds a list of nodes.

Parameters:

aNodes - Nodes to add.

See Also:

addNode(Node)

addEdge

public void addEdge(Edge aEdge)

Adds an edge.

Parameters:

aEdge - Edge to add.

Throws:

IllegalArgumentException - In case one of the nodes of the edges is not part of the graph or if the same edge (as determined by Object.equals(Object) is already a part of the graph.

removeEdge

public boolean removeEdge(Edge aEdge)

Removes an edge.

Parameters:

aEdge - Edge to remove.

Returns:

True if the edge was removed.

addEdges

public void addEdges(List<Edge> aEdges)

Adds a number of edges.

Parameters:

aEdges - Edges to add.

getNodes

public List<Node> getNodes()

Gets the nodes.

Returns:

Copy of the list of nodes of the graph.

getEdges

public List<Edge> getEdges()

Gets the edges.

Returns:

Copy of the list of edges of the graph.

extend

public void extend(EdgeFactory aFactory)

Extends the graph with edges using an edge factory. All combinations of nodes are passed to the factory which creates additional edges.

Parameters:

aFactory - Edge factory.

applyFilter

public void applyFilter(EdgeFilter aFilter)

Applies a filter to the graph for removing elements.

Parameters:

aFilter - Filter to apply.

findOutgoing

public List<Edge> findOutgoing(Node aNode)

Finds all outgoing edges of a node. More specifically, finds all edges e for which e.getFrom().getName() = aNode.getName().

Parameters:

aNode - Node for which to find outgoing edges.

Returns:

List of outgoing edges.

findIncoming

public List<Edge> findIncoming(Node aNode)

Finds all incoming edges of a node. More specifically, finds all edges e for which e.getTo().getName() = aNode.getName().

Parameters:

aNode - Node for which to find incoming edges.

Returns:

List of incoming edges.

accept

public void accept(Visitor aVisitor)

Implements a visitor design pattern. This loops over all nodes and all edges and invokes the appropriate visit methods on the visitor.

Parameters:

aVisitor - Visitor.