X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=system%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsystem%2Fgraph%2FGraph.java;h=f84873e3ee0b0a761223a060f91a5ccae08bd138;hb=f4d446b84fa1a38ed83cd157f79fdb8233822145;hp=ddfd2cf783a9003bb5a3db98d20ff02eb0631455;hpb=246a6a94ac725ea202a79591a69530014bf1da5f;p=utils diff --git a/system/general/src/main/java/org/wamblee/system/graph/Graph.java b/system/general/src/main/java/org/wamblee/system/graph/Graph.java index ddfd2cf7..f84873e3 100644 --- a/system/general/src/main/java/org/wamblee/system/graph/Graph.java +++ b/system/general/src/main/java/org/wamblee/system/graph/Graph.java @@ -1,12 +1,12 @@ /* * Copyright 2008 the original author or authors. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -19,46 +19,53 @@ import java.util.ArrayList; import java.util.Iterator; import java.util.List; + /** * Represents a graph consisting of nodes and edges. - * + * * @author Erik Brakkee */ public class Graph { - + /** + * DOCUMENT ME! + */ private List nodes; - private List edges; /** + * DOCUMENT ME! + */ + private List edges; + +/** * Constructs the graph. */ public Graph() { - nodes = new ArrayList(); - edges = new ArrayList(); + nodes = new ArrayList(); + edges = new ArrayList(); } /** * Adds a node. - * - * @param aNode - * Node to add. - * @throws IllegalArgumentException - * In case the node already exists. Node equality is checked - * using equals. + * + * @param aNode Node to add. + * + * @throws IllegalArgumentException In case the node already exists. Node + * equality is checked using equals. */ public void addNode(Node aNode) { if (nodes.contains(aNode)) { throw new IllegalArgumentException("Node '" + aNode.getName() - + "' already exists"); + + "' already exists"); } + nodes.add(aNode); } /** * Finds a node with the given name. - * - * @param aName - * Node name. + * + * @param aName Node name. + * * @return Node or null if not found. */ public Node findNode(String aName) { @@ -67,33 +74,35 @@ public class Graph { return node; } } + return null; } /** * Removes a node. - * - * @param aNode - * Node to remove. + * + * @param aNode Node to remove. + * * @return True iff the node was removed. - * @throws IllegalArgumentException - * In case there are edges of which the node is a part. + * + * @throws IllegalArgumentException In case there are edges of which the + * node is a part. */ public boolean removeNode(Node aNode) { if (!findOutgoing(aNode).isEmpty() || !findIncoming(aNode).isEmpty()) { throw new IllegalArgumentException("Cannot remove node '" - + aNode.getName() - + "' because it is connected to one or more edges"); + + aNode.getName() + + "' because it is connected to one or more edges"); } + return nodes.remove(aNode); } /** * Adds a list of nodes. - * - * @param aNodes - * Nodes to add. - * + * + * @param aNodes Nodes to add. + * * @see #addNode(Node) */ public void addNodes(List aNodes) { @@ -104,42 +113,47 @@ public class Graph { /** * Adds an edge. - * - * @param 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 - * {@link #equals(Object)} is already a part of the graph. + * + * @param 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 + * {@link #equals(Object)} is already a part of the graph. */ public void addEdge(Edge aEdge) { if (edges.contains(aEdge)) { throw new IllegalArgumentException("Edge '" + aEdge - + "' already exists"); + + "' already exists"); } + if (!nodes.contains(aEdge.getFrom())) { throw new IllegalArgumentException("From node '" + aEdge.getFrom() - + "' from edge '" + aEdge + "' is not part of the graph"); + + "' from edge '" + aEdge + "' is not part of the graph"); } + if (!nodes.contains(aEdge.getTo())) { throw new IllegalArgumentException("To node '" + aEdge.getTo() - + "' from edge '" + aEdge + "' is not part of the graph"); + + "' from edge '" + aEdge + "' is not part of the graph"); } + edges.add(aEdge); } /** - * Removes an edge. - * @param aEdge Edge to remove. - * @return True if the edge was removed. + * Removes an edge. + * + * @param aEdge Edge to remove. + * + * @return True if the edge was removed. */ public boolean removeEdge(Edge aEdge) { return edges.remove(aEdge); } /** - * Adds a number of edges. - * @param aEdges Edges to add. + * Adds a number of edges. + * + * @param aEdges Edges to add. */ public void addEdges(List aEdges) { for (Edge edge : aEdges) { @@ -148,25 +162,29 @@ public class Graph { } /** - * Gets the nodes. - * @return Copy of the list of nodes of the graph. + * Gets the nodes. + * + * @return Copy of the list of nodes of the graph. */ public List getNodes() { return new ArrayList(nodes); } /** - * Gets the edges. - * @return Copy of the list of edges of the graph. + * Gets the edges. + * + * @return Copy of the list of edges of the graph. */ public List getEdges() { return new ArrayList(edges); } /** - * Extends the graph with edges using an edge factory. All combinations of - * nodes are passed to the factory which creates additional edges. - * @param aFactory Edge factory. + * Extends the graph with edges using an edge factory. All + * combinations of nodes are passed to the factory which creates + * additional edges. + * + * @param aFactory Edge factory. */ public void extend(EdgeFactory aFactory) { for (Node from : nodes) { @@ -175,67 +193,79 @@ public class Graph { } } } - + /** - * Applies a filter to the graph for removing elements. - * @param aFilter Filter to apply. + * Applies a filter to the graph for removing elements. + * + * @param aFilter Filter to apply. */ public void applyFilter(EdgeFilter aFilter) { - for (Iterator edge = edges.iterator(); edge.hasNext(); ) { - if (aFilter.isViolated(edge.next())) { + for (Iterator edge = edges.iterator(); edge.hasNext();) { + if (aFilter.isViolated(edge.next())) { edge.remove(); } } } /** - * Finds all outgoing edges of a node. More specifically, finds - * all edges e for which e.getFrom().getName() = aNode.getName(). - * @param aNode Node for which to find outgoing edges. - * @return List of outgoing edges. + * Finds all outgoing edges of a node. More specifically, finds + * all edges e for which e.getFrom().getName() = + * aNode.getName(). + * + * @param aNode Node for which to find outgoing edges. + * + * @return List of outgoing edges. */ public List findOutgoing(Node aNode) { List result = new ArrayList(); + for (Edge edge : edges) { if (edge.getFrom().getName().equals(aNode.getName())) { result.add(edge); } } + return result; } /** - * Finds all incoming edges of a node. - * More specifically, finds - * all edges e for which e.getTo().getName() = aNode.getName(). - * @param aNode Node for which to find incoming edges. - * @return List of incoming edges. + * Finds all incoming edges of a node. More specifically, finds + * all edges e for which e.getTo().getName() = + * aNode.getName(). + * + * @param aNode Node for which to find incoming edges. + * + * @return List of incoming edges. */ public List findIncoming(Node aNode) { List result = new ArrayList(); + for (Edge edge : edges) { if (edge.getTo().getName().equals(aNode.getName())) { result.add(edge); } } + return result; } /** - * Implements a visitor design pattern. - * This loops over all nodes and all edges and invokes the appropriate visit - * methods on the visitor. - * @param aVisitor Visitor. + * Implements a visitor design pattern. This loops over all nodes + * and all edges and invokes the appropriate visit methods on the visitor. + * + * @param aVisitor Visitor. */ public void accept(Visitor aVisitor) { List nodes = getNodes(); // copy to make sure the visitor can - // modify the - // list of nodes as part of the loop. + // modify the + // list of nodes as part of the loop. + List edges = getEdges(); // copy ..... (see above). for (Node node : nodes) { aVisitor.visitNode(node); } + for (Edge edge : edges) { aVisitor.visitEdge(edge); }