blob: 4c6b773076b7019d339d213ad2a491877596ec53 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>AMIcallback xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../apidocs/org/eclipse/papyrus/designer/components/modellibs/core/mappingrules/AMIcallback.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_javadoccomment"> * All rights reserved. This program and the accompanying materials</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_javadoccomment"> * are made available under the terms of the Eclipse Public License v1.0</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_javadoccomment"> * which accompanies this distribution, and is available at</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_javadoccomment"> * <a href="http://www.eclipse.org/legal/epl-v10.htm" target="alexandria_uri">http://www.eclipse.org/legal/epl-v10.htm</a>l</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <strong class="jxr_keyword">package</strong> org.eclipse.papyrus.designer.components.modellibs.core.mappingrules;
<a class="jxr_linenumber" name="L8" href="#L8">8</a>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a class="jxr_linenumber" name="L10" href="#L10">10</a>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <strong class="jxr_keyword">import</strong> org.eclipse.papyrus.designer.components.FCM.Port;
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <strong class="jxr_keyword">import</strong> org.eclipse.papyrus.designer.components.FCM.profile.IMappingRule;
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <strong class="jxr_keyword">import</strong> org.eclipse.papyrus.designer.components.FCM.profile.PortMapUtil;
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <strong class="jxr_keyword">import</strong> org.eclipse.papyrus.designer.transformation.base.utils.RealizationUtils;
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <strong class="jxr_keyword">import</strong> org.eclipse.uml2.uml.Class;
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <strong class="jxr_keyword">import</strong> org.eclipse.uml2.uml.Interface;
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">import</strong> org.eclipse.uml2.uml.Operation;
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">import</strong> org.eclipse.uml2.uml.Parameter;
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> org.eclipse.uml2.uml.ParameterDirectionKind;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.eclipse.uml2.uml.Type;
<a class="jxr_linenumber" name="L21" href="#L21">21</a>
<a class="jxr_linenumber" name="L22" href="#L22">22</a>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../../org/eclipse/papyrus/designer/components/modellibs/core/mappingrules/AMIcallback.html">AMIcallback</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../../../org/eclipse/papyrus/designer/components/FCM/profile/IMappingRule.html">IMappingRule</a> {
<a class="jxr_linenumber" name="L24" href="#L24">24</a>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String _REPLY = <span class="jxr_string">"_reply_"</span>; <em class="jxr_comment">//$NON-NLS-1$</em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String _REQUEST = <span class="jxr_string">"_request_"</span>; <em class="jxr_comment">//$NON-NLS-1$</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String AMI_CB = <span class="jxr_string">"AMI_CB"</span>; <em class="jxr_comment">//$NON-NLS-1$</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> @Override
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">public</strong> Type calcDerivedType(<a href="../../../../../../../../org/eclipse/papyrus/designer/components/FCM/Port.html">Port</a> p, <strong class="jxr_keyword">boolean</strong> update) {
<a class="jxr_linenumber" name="L31" href="#L31">31</a> Type type = p.getType();
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">if</strong> (!(type instanceof Interface)) {
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> }
<a class="jxr_linenumber" name="L35" href="#L35">35</a>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> Interface typingInterface = (Interface) type;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> Class derivedType = PortMapUtil.getDerivedClass(p, AMI_CB);
<a class="jxr_linenumber" name="L38" href="#L38">38</a> Interface derivedRequestInterface = PortMapUtil.getDerivedInterface(p, _REQUEST);
<a class="jxr_linenumber" name="L39" href="#L39">39</a> Interface derivedReplyInterface = PortMapUtil.getDerivedInterface(p, _REPLY);
<a class="jxr_linenumber" name="L40" href="#L40">40</a> RealizationUtils.addUsage(derivedType, derivedRequestInterface); <em class="jxr_comment">// caller can use (require) the request interface</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> RealizationUtils.addRealization(derivedType, derivedReplyInterface); <em class="jxr_comment">// callers must implement (provide) the reply interface</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">if</strong> (!update) {
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">return</strong> derivedType;
<a class="jxr_linenumber" name="L45" href="#L45">45</a> }
<a class="jxr_linenumber" name="L46" href="#L46">46</a>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_comment">// -----------------------------------------------</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_comment">// calculate "request" interface (OUT parameter are removed)</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_comment">// -----------------------------------------------</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">for</strong> (Operation operation : typingInterface.getOwnedOperations()) {
<a class="jxr_linenumber" name="L51" href="#L51">51</a> String name = operation.getName();
<a class="jxr_linenumber" name="L52" href="#L52">52</a>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_comment">// check whether operation already exists. Create, if not</em>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> Operation derivedOperation = derivedRequestInterface.getOperation(name, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">if</strong> (derivedOperation == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L56" href="#L56">56</a> derivedOperation = derivedRequestInterface.createOwnedOperation(name, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L57" href="#L57">57</a> }
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_comment">// request operation contains only in and inout parameters</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">for</strong> (Parameter parameter : operation.getOwnedParameters()) {
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> ((parameter.getDirection() == ParameterDirectionKind.IN_LITERAL) ||
<a class="jxr_linenumber" name="L62" href="#L62">62</a> (parameter.getDirection() == ParameterDirectionKind.INOUT_LITERAL)) {
<a class="jxr_linenumber" name="L63" href="#L63">63</a>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> String paramName = parameter.getName();
<a class="jxr_linenumber" name="L65" href="#L65">65</a> Type paramType = parameter.getType();
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> (derivedOperation.getOwnedParameter(paramName, paramType) == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> Parameter newParameter = derivedOperation.createOwnedParameter(parameter.getName(), parameter.getType());
<a class="jxr_linenumber" name="L68" href="#L68">68</a> newParameter.setDirection(parameter.getDirection());
<a class="jxr_linenumber" name="L69" href="#L69">69</a> newParameter.setLower(parameter.getLower());
<a class="jxr_linenumber" name="L70" href="#L70">70</a> newParameter.setUpper(parameter.getUpper());
<a class="jxr_linenumber" name="L71" href="#L71">71</a> }
<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_comment">// remove those parameters that exist in derived, but not original interface.</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> Iterator&lt;Parameter&gt; derivedParameters = derivedOperation.getOwnedParameters().iterator();
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">while</strong> (derivedParameters.hasNext()) {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> Parameter parameter = derivedParameters.next();
<a class="jxr_linenumber" name="L79" href="#L79">79</a> String paramName = parameter.getName();
<a class="jxr_linenumber" name="L80" href="#L80">80</a> Type paramType = parameter.getType();
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (operation.getOwnedParameter(paramName, paramType) == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_comment">// not on in original interface, remove from derived as well</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> derivedParameters.remove();
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// check whether operations in derived interface exist in original interface</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// (remove, if not)</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> Iterator&lt;Operation&gt; derivedRequestOperations = derivedRequestInterface.getOwnedOperations().iterator();
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">while</strong> (derivedRequestOperations.hasNext()) {
<a class="jxr_linenumber" name="L92" href="#L92">92</a> Operation derivedOperation = derivedRequestOperations.next();
<a class="jxr_linenumber" name="L93" href="#L93">93</a> String name = derivedOperation.getName();
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">continue</strong>;
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">if</strong> (typingInterface.getOperation(name, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>) == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_comment">// not in typing interface, remove</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> derivedRequestOperations.remove();
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_comment">// -----------------------------------------------</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_comment">// calculate "reply" interface (with OUT and INOUT parameter transformed into in parameters)</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_comment">// -----------------------------------------------</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">for</strong> (Operation operation : typingInterface.getOwnedOperations()) {
<a class="jxr_linenumber" name="L107" href="#L107">107</a> String name = operation.getName();
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">if</strong> (AMIpoll.hasOutParameters(operation)) {
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_comment">// check whether operation already exists. Create, if not</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> Operation derivedOperation = derivedReplyInterface.getOperation(name, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">if</strong> (derivedOperation == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> derivedOperation = derivedReplyInterface.createOwnedOperation(name, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_comment">// each non-in parameter is in the poll operation.</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">for</strong> (Parameter parameter : operation.getOwnedParameters()) {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">if</strong> (parameter.getDirection() != ParameterDirectionKind.IN_LITERAL) { <em class="jxr_comment">// OUT and INOUT</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> String paramName = parameter.getName();
<a class="jxr_linenumber" name="L122" href="#L122">122</a> Type paramType = parameter.getType();
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">if</strong> (derivedOperation.getOwnedParameter(paramName, paramType) == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> Parameter newParameter = derivedOperation.createOwnedParameter(parameter.getName(), parameter.getType());
<a class="jxr_linenumber" name="L125" href="#L125">125</a> newParameter.setDirection(ParameterDirectionKind.IN_LITERAL);
<a class="jxr_linenumber" name="L126" href="#L126">126</a> newParameter.setLower(parameter.getLower());
<a class="jxr_linenumber" name="L127" href="#L127">127</a> newParameter.setUpper(parameter.getUpper());
<a class="jxr_linenumber" name="L128" href="#L128">128</a> }
<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
<a class="jxr_linenumber" name="L131" href="#L131">131</a>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_comment">// remove those parameters that exist in derived, but not original interface.</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> Iterator&lt;Parameter&gt; derivedParameters = derivedOperation.getOwnedParameters().iterator();
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">while</strong> (derivedParameters.hasNext()) {
<a class="jxr_linenumber" name="L135" href="#L135">135</a> Parameter parameter = derivedParameters.next();
<a class="jxr_linenumber" name="L136" href="#L136">136</a> String paramName = parameter.getName();
<a class="jxr_linenumber" name="L137" href="#L137">137</a> Type paramType = parameter.getType();
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">if</strong> (operation.getOwnedParameter(paramName, paramType) == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_comment">// not on in original interface, remove from derived as well</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> derivedParameters.remove();
<a class="jxr_linenumber" name="L141" href="#L141">141</a> }
<a class="jxr_linenumber" name="L142" href="#L142">142</a> }
<a class="jxr_linenumber" name="L143" href="#L143">143</a> }
<a class="jxr_linenumber" name="L144" href="#L144">144</a> }
<a class="jxr_linenumber" name="L145" href="#L145">145</a>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_comment">// check whether operations in derived interface exist in original interface</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_comment">// (remove, if not)</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> Iterator&lt;Operation&gt; derivedReplyOperations = derivedReplyInterface.getOwnedOperations().iterator();
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">while</strong> (derivedRequestOperations.hasNext()) {
<a class="jxr_linenumber" name="L150" href="#L150">150</a> Operation derivedOperation = derivedReplyOperations.next();
<a class="jxr_linenumber" name="L151" href="#L151">151</a> String name = derivedOperation.getName();
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">continue</strong>;
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (typingInterface.getOperation(name, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>) == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_comment">// not in typing interface, remove</em>
<a class="jxr_linenumber" name="L157" href="#L157">157</a> derivedReplyOperations.remove();
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
<a class="jxr_linenumber" name="L159" href="#L159">159</a> }
<a class="jxr_linenumber" name="L160" href="#L160">160</a>
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">return</strong> derivedType;
<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
<a class="jxr_linenumber" name="L163" href="#L163">163</a>
<a class="jxr_linenumber" name="L164" href="#L164">164</a> @Override
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> needsUpdate(<a href="../../../../../../../../org/eclipse/papyrus/designer/components/FCM/Port.html">Port</a> p) {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_comment">// TODO: insufficient condition</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong> (calcDerivedType(p, false) == <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
<a class="jxr_linenumber" name="L169" href="#L169">169</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2016&#x2013;2017 <a href="https://www.eclipse.org/">Eclipse foundation</a>. All rights reserved.</div>
</body>
</html>