d06280c971460aaf85f948fdf64a71d349850ba9
[utils] / system / general / src / main / java / org / wamblee / system / graph / component / LinkVisitor.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.ProvidedInterface;
19 import org.wamblee.system.core.SystemAssemblyException;
20 import org.wamblee.system.graph.DefaultEdge;
21 import org.wamblee.system.graph.Edge;
22 import org.wamblee.system.graph.Node;
23 import org.wamblee.system.graph.Visitor;
24
25
26 /**
27  * Visitor that creates links between required and provided interfaces as
28  * described by the edges in the graph.  Specically it links together (1)
29  * required and provided interfaces of internal component  of a container and
30  * (2) the providers of externally required interfaces and internal required
31  * interfaces.
32  *
33  * @author Erik Brakkee
34  */
35 public class LinkVisitor implements Visitor {
36     /**
37      * DOCUMENT ME!
38      *
39      * @param aEdge DOCUMENT ME!
40      */
41     @Override
42     public void visitEdge(Edge aEdge) {
43         Node from = aEdge.getFrom();
44         Node to   = aEdge.getTo();
45
46         if (from instanceof RequiredInterfaceNode) {
47             RequiredInterfaceNode required = (RequiredInterfaceNode) from;
48
49             if (to instanceof ProvidedInterfaceNode) {
50                 ProvidedInterfaceNode provided = (ProvidedInterfaceNode) to;
51                 required.getRequired().setProvider(provided.getProvided());
52             } else if (to instanceof ExternalRequiredInterfaceNode) {
53                 ExternalRequiredInterfaceNode external = (ExternalRequiredInterfaceNode) to;
54                 ProvidedInterface             provider = external.getRequired()
55                     .getProvider();
56
57                 if ((provider == null) && !required.getRequired().isOptional()) {
58                     throw new SystemAssemblyException("Mandatory interface '"
59                         + from + "' is not provided.");
60                 }
61
62                 if (provider != null) {
63                     required.getRequired().setProvider(provider);
64                 }
65             }
66         } else if (from instanceof ProvidedInterfaceNode) {
67             // Provided interfaces can only be published after the system has
68             // started.
69         }
70     }
71
72     /**
73      * DOCUMENT ME!
74      *
75      * @param aNode DOCUMENT ME!
76      */
77     @Override
78     public void visitNode(Node aNode) {
79         // Empty.
80     }
81 }