(no commit message)
[utils] / system / general / src / main / java / org / wamblee / system / graph / component / CheckExternallyProvidedVisitor.java
1 /*
2  * Copyright 2005-2010 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.wamblee.system.graph.component;
17
18 import org.wamblee.system.core.SystemAssemblyException;
19 import org.wamblee.system.graph.Edge;
20 import org.wamblee.system.graph.Graph;
21 import org.wamblee.system.graph.Node;
22 import org.wamblee.system.graph.Visitor;
23
24 import java.util.List;
25
26 /**
27  * Visitor that checks whether all externally provided interfaces are actually
28  * provided by any of the internal components.
29  * 
30  * @author Erik Brakkee
31  */
32 public class CheckExternallyProvidedVisitor implements Visitor {
33     private Graph graph;
34
35     /**
36      * Constructs the visitor.
37      * 
38      * @param aGraph
39      *            Component graph.
40      */
41     public CheckExternallyProvidedVisitor(Graph aGraph) {
42         graph = aGraph;
43     }
44
45     @Override
46     public void visitEdge(Edge aEdge) {
47         // Empty.
48     }
49
50     @Override
51     public void visitNode(Node aNode) {
52         if (aNode instanceof ExternalProvidedInterfaceNode) {
53             ExternalProvidedInterfaceNode provided = (ExternalProvidedInterfaceNode) aNode;
54             List<Edge> edges = graph.findOutgoing(provided);
55
56             if (edges.size() > 2) {
57                 createDuplicateException(
58                     "External provided interfaces has multiple internal matches",
59                     aNode, edges);
60             }
61
62             if (edges.size() == 0) {
63                 throw new SystemAssemblyException(
64                     aNode +
65                         ": external provded interface is not provided by any of the internal components");
66             }
67         }
68     }
69
70     private void createDuplicateException(String aMsg, Node aNode,
71         List<Edge> aEdges) {
72         StringBuffer buf = new StringBuffer();
73         buf.append(aNode + ": " + aMsg + ": ");
74
75         for (Edge edge : aEdges) {
76             buf.append(edge.getTo() + "/ ");
77         }
78
79         throw new SystemAssemblyException(buf.toString());
80     }
81 }