wamblee.org Git - utils/blob - system/general/src/main/java/org/wamblee/system/graph/component/CheckRequiredProvidedMultiplicityVisitor.java

   1 /*
   2  * Copyright 2008 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 /**
  28  * Visitor that checks whether required and provided interfaces are matched
  29  * appropriately:
  30  *  <ul>
  31  *      <li>Each required interface is connected to at most one
  32  *      provided interface</li>
  33  *      <li>Required interfaces that are not optional must be connected
  34  *      to precisely one provided interface</li>
  35  *  </ul>
  36  *
  37  * @author Erik Brakkee
  38  */
  39 public class CheckRequiredProvidedMultiplicityVisitor implements Visitor {
  40     /**
  41      * DOCUMENT ME!
  42      */
  43     private Graph graph;
  44
  45     /**
  46      * Creates a new CheckRequiredProvidedMultiplicityVisitor object.
  47      *
  48      * @param aGraph DOCUMENT ME!
  49      */
  50     public CheckRequiredProvidedMultiplicityVisitor(Graph aGraph) {
  51         graph = aGraph;
  52     }
  53
  54     /**
  55      * DOCUMENT ME!
  56      *
  57      * @param aEdge DOCUMENT ME!
  58      */
  59     @Override
  60     public void visitEdge(Edge aEdge) {
  61         // Empty
  62     }
  63
  64     /**
  65      * DOCUMENT ME!
  66      *
  67      * @param aNode DOCUMENT ME!
  68      */
  69     @Override
  70     public void visitNode(Node aNode) {
  71         if (aNode instanceof RequiredInterfaceNode) {
  72             RequiredInterfaceNode required = (RequiredInterfaceNode) aNode;
  73             List<Edge>            edges    = graph.findOutgoing(aNode);
  74
  75             if (edges.size() > 1) {
  76                 createDuplicateException("Multiple providers of required interface found",
  77                     aNode, edges);
  78             }
  79
  80             if ((edges.size() == 0) && !required.getRequired().isOptional()) {
  81                 throw new SystemAssemblyException(aNode
  82                     + ": mandatpory required interface not provided by other components started earlier");
  83             }
  84         } else if (aNode instanceof ExternalProvidedInterfaceNode) {
  85             List<Edge> edges = graph.findOutgoing(aNode);
  86
  87             if (edges.size() > 1) {
  88                 createDuplicateException("multiple internal matches for externally provided interface",
  89                     aNode, edges);
  90             }
  91
  92             if (edges.size() == 0) {
  93                 throw new SystemAssemblyException(aNode
  94                     + ": external provided interface is not provided internally");
  95             }
  96         }
  97     }
  98
  99     /**
 100      * DOCUMENT ME!
 101      *
 102      * @param aMsg DOCUMENT ME!
 103      * @param aNode DOCUMENT ME!
 104      * @param edges DOCUMENT ME!
 105      */
 106     private void createDuplicateException(String aMsg, Node aNode,
 107         List<Edge> edges) {
 108         StringBuffer buf = new StringBuffer();
 109         buf.append(aNode + ": " + aMsg + ": ");
 110
 111         for (Edge edge : edges) {
 112             buf.append(edge.getTo() + "/ ");
 113         }
 114
 115         throw new SystemAssemblyException(buf.toString());
 116     }
 117 }