1------------------------------------------------------------------------------
2--                                                                          --
3--                            Matreshka Project                             --
4--                                                                          --
5--                          Ada Modeling Framework                          --
6--                                                                          --
7--                        Runtime Library Component                         --
8--                                                                          --
9------------------------------------------------------------------------------
10--                                                                          --
11-- Copyright © 2011-2012, Vadim Godunko <vgodunko@gmail.com>                --
12-- All rights reserved.                                                     --
13--                                                                          --
14-- Redistribution and use in source and binary forms, with or without       --
15-- modification, are permitted provided that the following conditions       --
16-- are met:                                                                 --
17--                                                                          --
18--  * Redistributions of source code must retain the above copyright        --
19--    notice, this list of conditions and the following disclaimer.         --
20--                                                                          --
21--  * Redistributions in binary form must reproduce the above copyright     --
22--    notice, this list of conditions and the following disclaimer in the   --
23--    documentation and/or other materials provided with the distribution.  --
24--                                                                          --
25--  * Neither the name of the Vadim Godunko, IE nor the names of its        --
26--    contributors may be used to endorse or promote products derived from  --
27--    this software without specific prior written permission.              --
28--                                                                          --
29-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS      --
30-- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT        --
31-- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR    --
32-- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT     --
33-- HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,   --
34-- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED --
35-- TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR   --
36-- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF   --
37-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     --
38-- NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS       --
39-- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.             --
40--                                                                          --
41------------------------------------------------------------------------------
42--  $Revision: 2937 $ $Date: 2012-05-01 21:07:27 +0400 (Tue, 01 May 2012) $
43------------------------------------------------------------------------------
44with AMF.Internals.UML_Named_Elements;
45with AMF.UML.Activities;
46with AMF.UML.Activity_Edges.Collections;
47with AMF.UML.Activity_Groups.Collections;
48with AMF.UML.Activity_Nodes.Collections;
49with AMF.UML.Activity_Partitions.Collections;
50with AMF.UML.Classifiers.Collections;
51with AMF.UML.Dependencies.Collections;
52with AMF.UML.Interruptible_Activity_Regions.Collections;
53with AMF.UML.Join_Nodes;
54with AMF.UML.Named_Elements;
55with AMF.UML.Namespaces;
56with AMF.UML.Packages.Collections;
57with AMF.UML.Redefinable_Elements.Collections;
58with AMF.UML.String_Expressions;
59with AMF.UML.Structured_Activity_Nodes;
60with AMF.UML.Value_Specifications;
61with AMF.Visitors;
62
63package AMF.Internals.UML_Join_Nodes is
64
65   type UML_Join_Node_Proxy is
66     limited new AMF.Internals.UML_Named_Elements.UML_Named_Element_Proxy
67       and AMF.UML.Join_Nodes.UML_Join_Node with null record;
68
69   overriding function Get_Is_Combine_Duplicate
70    (Self : not null access constant UML_Join_Node_Proxy)
71       return Boolean;
72   --  Getter of JoinNode::isCombineDuplicate.
73   --
74   --  Tells whether tokens having objects with the same identity are combined
75   --  into one by the join.
76
77   overriding procedure Set_Is_Combine_Duplicate
78    (Self : not null access UML_Join_Node_Proxy;
79     To   : Boolean);
80   --  Setter of JoinNode::isCombineDuplicate.
81   --
82   --  Tells whether tokens having objects with the same identity are combined
83   --  into one by the join.
84
85   overriding function Get_Join_Spec
86    (Self : not null access constant UML_Join_Node_Proxy)
87       return AMF.UML.Value_Specifications.UML_Value_Specification_Access;
88   --  Getter of JoinNode::joinSpec.
89   --
90   --  A specification giving the conditions under which the join with emit a
91   --  token. Default is 'and'.
92
93   overriding procedure Set_Join_Spec
94    (Self : not null access UML_Join_Node_Proxy;
95     To   : AMF.UML.Value_Specifications.UML_Value_Specification_Access);
96   --  Setter of JoinNode::joinSpec.
97   --
98   --  A specification giving the conditions under which the join with emit a
99   --  token. Default is 'and'.
100
101   overriding function Get_Activity
102    (Self : not null access constant UML_Join_Node_Proxy)
103       return AMF.UML.Activities.UML_Activity_Access;
104   --  Getter of ActivityNode::activity.
105   --
106   --  Activity containing the node.
107
108   overriding procedure Set_Activity
109    (Self : not null access UML_Join_Node_Proxy;
110     To   : AMF.UML.Activities.UML_Activity_Access);
111   --  Setter of ActivityNode::activity.
112   --
113   --  Activity containing the node.
114
115   overriding function Get_In_Group
116    (Self : not null access constant UML_Join_Node_Proxy)
117       return AMF.UML.Activity_Groups.Collections.Set_Of_UML_Activity_Group;
118   --  Getter of ActivityNode::inGroup.
119   --
120   --  Groups containing the node.
121
122   overriding function Get_In_Interruptible_Region
123    (Self : not null access constant UML_Join_Node_Proxy)
124       return AMF.UML.Interruptible_Activity_Regions.Collections.Set_Of_UML_Interruptible_Activity_Region;
125   --  Getter of ActivityNode::inInterruptibleRegion.
126   --
127   --  Interruptible regions containing the node.
128
129   overriding function Get_In_Partition
130    (Self : not null access constant UML_Join_Node_Proxy)
131       return AMF.UML.Activity_Partitions.Collections.Set_Of_UML_Activity_Partition;
132   --  Getter of ActivityNode::inPartition.
133   --
134   --  Partitions containing the node.
135
136   overriding function Get_In_Structured_Node
137    (Self : not null access constant UML_Join_Node_Proxy)
138       return AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access;
139   --  Getter of ActivityNode::inStructuredNode.
140   --
141   --  Structured activity node containing the node.
142
143   overriding procedure Set_In_Structured_Node
144    (Self : not null access UML_Join_Node_Proxy;
145     To   : AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access);
146   --  Setter of ActivityNode::inStructuredNode.
147   --
148   --  Structured activity node containing the node.
149
150   overriding function Get_Incoming
151    (Self : not null access constant UML_Join_Node_Proxy)
152       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
153   --  Getter of ActivityNode::incoming.
154   --
155   --  Edges that have the node as target.
156
157   overriding function Get_Outgoing
158    (Self : not null access constant UML_Join_Node_Proxy)
159       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
160   --  Getter of ActivityNode::outgoing.
161   --
162   --  Edges that have the node as source.
163
164   overriding function Get_Redefined_Node
165    (Self : not null access constant UML_Join_Node_Proxy)
166       return AMF.UML.Activity_Nodes.Collections.Set_Of_UML_Activity_Node;
167   --  Getter of ActivityNode::redefinedNode.
168   --
169   --  Inherited nodes replaced by this node in a specialization of the
170   --  activity.
171
172   overriding function Get_Is_Leaf
173    (Self : not null access constant UML_Join_Node_Proxy)
174       return Boolean;
175   --  Getter of RedefinableElement::isLeaf.
176   --
177   --  Indicates whether it is possible to further redefine a
178   --  RedefinableElement. If the value is true, then it is not possible to
179   --  further redefine the RedefinableElement. Note that this property is
180   --  preserved through package merge operations; that is, the capability to
181   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
182   --  the resulting RedefinableElement of a package merge operation where a
183   --  RedefinableElement with isLeaf=false is merged with a matching
184   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
185   --  will have isLeaf=false. Default value is false.
186
187   overriding procedure Set_Is_Leaf
188    (Self : not null access UML_Join_Node_Proxy;
189     To   : Boolean);
190   --  Setter of RedefinableElement::isLeaf.
191   --
192   --  Indicates whether it is possible to further redefine a
193   --  RedefinableElement. If the value is true, then it is not possible to
194   --  further redefine the RedefinableElement. Note that this property is
195   --  preserved through package merge operations; that is, the capability to
196   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
197   --  the resulting RedefinableElement of a package merge operation where a
198   --  RedefinableElement with isLeaf=false is merged with a matching
199   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
200   --  will have isLeaf=false. Default value is false.
201
202   overriding function Get_Redefined_Element
203    (Self : not null access constant UML_Join_Node_Proxy)
204       return AMF.UML.Redefinable_Elements.Collections.Set_Of_UML_Redefinable_Element;
205   --  Getter of RedefinableElement::redefinedElement.
206   --
207   --  The redefinable element that is being redefined by this element.
208
209   overriding function Get_Redefinition_Context
210    (Self : not null access constant UML_Join_Node_Proxy)
211       return AMF.UML.Classifiers.Collections.Set_Of_UML_Classifier;
212   --  Getter of RedefinableElement::redefinitionContext.
213   --
214   --  References the contexts that this element may be redefined from.
215
216   overriding function Get_Client_Dependency
217    (Self : not null access constant UML_Join_Node_Proxy)
218       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
219   --  Getter of NamedElement::clientDependency.
220   --
221   --  Indicates the dependencies that reference the client.
222
223   overriding function Get_Name_Expression
224    (Self : not null access constant UML_Join_Node_Proxy)
225       return AMF.UML.String_Expressions.UML_String_Expression_Access;
226   --  Getter of NamedElement::nameExpression.
227   --
228   --  The string expression used to define the name of this named element.
229
230   overriding procedure Set_Name_Expression
231    (Self : not null access UML_Join_Node_Proxy;
232     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
233   --  Setter of NamedElement::nameExpression.
234   --
235   --  The string expression used to define the name of this named element.
236
237   overriding function Get_Namespace
238    (Self : not null access constant UML_Join_Node_Proxy)
239       return AMF.UML.Namespaces.UML_Namespace_Access;
240   --  Getter of NamedElement::namespace.
241   --
242   --  Specifies the namespace that owns the NamedElement.
243
244   overriding function Get_Qualified_Name
245    (Self : not null access constant UML_Join_Node_Proxy)
246       return AMF.Optional_String;
247   --  Getter of NamedElement::qualifiedName.
248   --
249   --  A name which allows the NamedElement to be identified within a
250   --  hierarchy of nested Namespaces. It is constructed from the names of the
251   --  containing namespaces starting at the root of the hierarchy and ending
252   --  with the name of the NamedElement itself.
253
254   overriding function Is_Consistent_With
255    (Self : not null access constant UML_Join_Node_Proxy;
256     Redefinee : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
257       return Boolean;
258   --  Operation RedefinableElement::isConsistentWith.
259   --
260   --  The query isConsistentWith() specifies, for any two RedefinableElements
261   --  in a context in which redefinition is possible, whether redefinition
262   --  would be logically consistent. By default, this is false; this
263   --  operation must be overridden for subclasses of RedefinableElement to
264   --  define the consistency conditions.
265
266   overriding function Is_Redefinition_Context_Valid
267    (Self : not null access constant UML_Join_Node_Proxy;
268     Redefined : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
269       return Boolean;
270   --  Operation RedefinableElement::isRedefinitionContextValid.
271   --
272   --  The query isRedefinitionContextValid() specifies whether the
273   --  redefinition contexts of this RedefinableElement are properly related
274   --  to the redefinition contexts of the specified RedefinableElement to
275   --  allow this element to redefine the other. By default at least one of
276   --  the redefinition contexts of this element must be a specialization of
277   --  at least one of the redefinition contexts of the specified element.
278
279   overriding function All_Owning_Packages
280    (Self : not null access constant UML_Join_Node_Proxy)
281       return AMF.UML.Packages.Collections.Set_Of_UML_Package;
282   --  Operation NamedElement::allOwningPackages.
283   --
284   --  The query allOwningPackages() returns all the directly or indirectly
285   --  owning packages.
286
287   overriding function Is_Distinguishable_From
288    (Self : not null access constant UML_Join_Node_Proxy;
289     N : AMF.UML.Named_Elements.UML_Named_Element_Access;
290     Ns : AMF.UML.Namespaces.UML_Namespace_Access)
291       return Boolean;
292   --  Operation NamedElement::isDistinguishableFrom.
293   --
294   --  The query isDistinguishableFrom() determines whether two NamedElements
295   --  may logically co-exist within a Namespace. By default, two named
296   --  elements are distinguishable if (a) they have unrelated types or (b)
297   --  they have related types but different names.
298
299   overriding function Namespace
300    (Self : not null access constant UML_Join_Node_Proxy)
301       return AMF.UML.Namespaces.UML_Namespace_Access;
302   --  Operation NamedElement::namespace.
303   --
304   --  Missing derivation for NamedElement::/namespace : Namespace
305
306   overriding procedure Enter_Element
307    (Self    : not null access constant UML_Join_Node_Proxy;
308     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
309     Control : in out AMF.Visitors.Traverse_Control);
310   --  Dispatch call to corresponding subprogram of visitor interface.
311
312   overriding procedure Leave_Element
313    (Self    : not null access constant UML_Join_Node_Proxy;
314     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
315     Control : in out AMF.Visitors.Traverse_Control);
316   --  Dispatch call to corresponding subprogram of visitor interface.
317
318   overriding procedure Visit_Element
319    (Self     : not null access constant UML_Join_Node_Proxy;
320     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
321     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
322     Control  : in out AMF.Visitors.Traverse_Control);
323   --  Dispatch call to corresponding subprogram of iterator interface.
324
325end AMF.Internals.UML_Join_Nodes;
326