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.Behaviors;
51with AMF.UML.Classifiers.Collections;
52with AMF.UML.Data_Store_Nodes;
53with AMF.UML.Dependencies.Collections;
54with AMF.UML.Interruptible_Activity_Regions.Collections;
55with AMF.UML.Named_Elements;
56with AMF.UML.Namespaces;
57with AMF.UML.Packages.Collections;
58with AMF.UML.Redefinable_Elements.Collections;
59with AMF.UML.States.Collections;
60with AMF.UML.String_Expressions;
61with AMF.UML.Structured_Activity_Nodes;
62with AMF.UML.Types;
63with AMF.UML.Value_Specifications;
64with AMF.Visitors;
65
66package AMF.Internals.UML_Data_Store_Nodes is
67
68   type UML_Data_Store_Node_Proxy is
69     limited new AMF.Internals.UML_Named_Elements.UML_Named_Element_Proxy
70       and AMF.UML.Data_Store_Nodes.UML_Data_Store_Node with null record;
71
72   overriding function Get_In_State
73    (Self : not null access constant UML_Data_Store_Node_Proxy)
74       return AMF.UML.States.Collections.Set_Of_UML_State;
75   --  Getter of ObjectNode::inState.
76   --
77   --  The required states of the object available at this point in the
78   --  activity.
79
80   overriding function Get_Is_Control_Type
81    (Self : not null access constant UML_Data_Store_Node_Proxy)
82       return Boolean;
83   --  Getter of ObjectNode::isControlType.
84   --
85   --  Tells whether the type of the object node is to be treated as control.
86
87   overriding procedure Set_Is_Control_Type
88    (Self : not null access UML_Data_Store_Node_Proxy;
89     To   : Boolean);
90   --  Setter of ObjectNode::isControlType.
91   --
92   --  Tells whether the type of the object node is to be treated as control.
93
94   overriding function Get_Ordering
95    (Self : not null access constant UML_Data_Store_Node_Proxy)
96       return AMF.UML.UML_Object_Node_Ordering_Kind;
97   --  Getter of ObjectNode::ordering.
98   --
99   --  Tells whether and how the tokens in the object node are ordered for
100   --  selection to traverse edges outgoing from the object node.
101
102   overriding procedure Set_Ordering
103    (Self : not null access UML_Data_Store_Node_Proxy;
104     To   : AMF.UML.UML_Object_Node_Ordering_Kind);
105   --  Setter of ObjectNode::ordering.
106   --
107   --  Tells whether and how the tokens in the object node are ordered for
108   --  selection to traverse edges outgoing from the object node.
109
110   overriding function Get_Selection
111    (Self : not null access constant UML_Data_Store_Node_Proxy)
112       return AMF.UML.Behaviors.UML_Behavior_Access;
113   --  Getter of ObjectNode::selection.
114   --
115   --  Selects tokens for outgoing edges.
116
117   overriding procedure Set_Selection
118    (Self : not null access UML_Data_Store_Node_Proxy;
119     To   : AMF.UML.Behaviors.UML_Behavior_Access);
120   --  Setter of ObjectNode::selection.
121   --
122   --  Selects tokens for outgoing edges.
123
124   overriding function Get_Upper_Bound
125    (Self : not null access constant UML_Data_Store_Node_Proxy)
126       return AMF.UML.Value_Specifications.UML_Value_Specification_Access;
127   --  Getter of ObjectNode::upperBound.
128   --
129   --  The maximum number of tokens allowed in the node. Objects cannot flow
130   --  into the node if the upper bound is reached.
131
132   overriding procedure Set_Upper_Bound
133    (Self : not null access UML_Data_Store_Node_Proxy;
134     To   : AMF.UML.Value_Specifications.UML_Value_Specification_Access);
135   --  Setter of ObjectNode::upperBound.
136   --
137   --  The maximum number of tokens allowed in the node. Objects cannot flow
138   --  into the node if the upper bound is reached.
139
140   overriding function Get_Activity
141    (Self : not null access constant UML_Data_Store_Node_Proxy)
142       return AMF.UML.Activities.UML_Activity_Access;
143   --  Getter of ActivityNode::activity.
144   --
145   --  Activity containing the node.
146
147   overriding procedure Set_Activity
148    (Self : not null access UML_Data_Store_Node_Proxy;
149     To   : AMF.UML.Activities.UML_Activity_Access);
150   --  Setter of ActivityNode::activity.
151   --
152   --  Activity containing the node.
153
154   overriding function Get_In_Group
155    (Self : not null access constant UML_Data_Store_Node_Proxy)
156       return AMF.UML.Activity_Groups.Collections.Set_Of_UML_Activity_Group;
157   --  Getter of ActivityNode::inGroup.
158   --
159   --  Groups containing the node.
160
161   overriding function Get_In_Interruptible_Region
162    (Self : not null access constant UML_Data_Store_Node_Proxy)
163       return AMF.UML.Interruptible_Activity_Regions.Collections.Set_Of_UML_Interruptible_Activity_Region;
164   --  Getter of ActivityNode::inInterruptibleRegion.
165   --
166   --  Interruptible regions containing the node.
167
168   overriding function Get_In_Partition
169    (Self : not null access constant UML_Data_Store_Node_Proxy)
170       return AMF.UML.Activity_Partitions.Collections.Set_Of_UML_Activity_Partition;
171   --  Getter of ActivityNode::inPartition.
172   --
173   --  Partitions containing the node.
174
175   overriding function Get_In_Structured_Node
176    (Self : not null access constant UML_Data_Store_Node_Proxy)
177       return AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access;
178   --  Getter of ActivityNode::inStructuredNode.
179   --
180   --  Structured activity node containing the node.
181
182   overriding procedure Set_In_Structured_Node
183    (Self : not null access UML_Data_Store_Node_Proxy;
184     To   : AMF.UML.Structured_Activity_Nodes.UML_Structured_Activity_Node_Access);
185   --  Setter of ActivityNode::inStructuredNode.
186   --
187   --  Structured activity node containing the node.
188
189   overriding function Get_Incoming
190    (Self : not null access constant UML_Data_Store_Node_Proxy)
191       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
192   --  Getter of ActivityNode::incoming.
193   --
194   --  Edges that have the node as target.
195
196   overriding function Get_Outgoing
197    (Self : not null access constant UML_Data_Store_Node_Proxy)
198       return AMF.UML.Activity_Edges.Collections.Set_Of_UML_Activity_Edge;
199   --  Getter of ActivityNode::outgoing.
200   --
201   --  Edges that have the node as source.
202
203   overriding function Get_Redefined_Node
204    (Self : not null access constant UML_Data_Store_Node_Proxy)
205       return AMF.UML.Activity_Nodes.Collections.Set_Of_UML_Activity_Node;
206   --  Getter of ActivityNode::redefinedNode.
207   --
208   --  Inherited nodes replaced by this node in a specialization of the
209   --  activity.
210
211   overriding function Get_Is_Leaf
212    (Self : not null access constant UML_Data_Store_Node_Proxy)
213       return Boolean;
214   --  Getter of RedefinableElement::isLeaf.
215   --
216   --  Indicates whether it is possible to further redefine a
217   --  RedefinableElement. If the value is true, then it is not possible to
218   --  further redefine the RedefinableElement. Note that this property is
219   --  preserved through package merge operations; that is, the capability to
220   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
221   --  the resulting RedefinableElement of a package merge operation where a
222   --  RedefinableElement with isLeaf=false is merged with a matching
223   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
224   --  will have isLeaf=false. Default value is false.
225
226   overriding procedure Set_Is_Leaf
227    (Self : not null access UML_Data_Store_Node_Proxy;
228     To   : Boolean);
229   --  Setter of RedefinableElement::isLeaf.
230   --
231   --  Indicates whether it is possible to further redefine a
232   --  RedefinableElement. If the value is true, then it is not possible to
233   --  further redefine the RedefinableElement. Note that this property is
234   --  preserved through package merge operations; that is, the capability to
235   --  redefine a RedefinableElement (i.e., isLeaf=false) must be preserved in
236   --  the resulting RedefinableElement of a package merge operation where a
237   --  RedefinableElement with isLeaf=false is merged with a matching
238   --  RedefinableElement with isLeaf=true: the resulting RedefinableElement
239   --  will have isLeaf=false. Default value is false.
240
241   overriding function Get_Redefined_Element
242    (Self : not null access constant UML_Data_Store_Node_Proxy)
243       return AMF.UML.Redefinable_Elements.Collections.Set_Of_UML_Redefinable_Element;
244   --  Getter of RedefinableElement::redefinedElement.
245   --
246   --  The redefinable element that is being redefined by this element.
247
248   overriding function Get_Redefinition_Context
249    (Self : not null access constant UML_Data_Store_Node_Proxy)
250       return AMF.UML.Classifiers.Collections.Set_Of_UML_Classifier;
251   --  Getter of RedefinableElement::redefinitionContext.
252   --
253   --  References the contexts that this element may be redefined from.
254
255   overriding function Get_Client_Dependency
256    (Self : not null access constant UML_Data_Store_Node_Proxy)
257       return AMF.UML.Dependencies.Collections.Set_Of_UML_Dependency;
258   --  Getter of NamedElement::clientDependency.
259   --
260   --  Indicates the dependencies that reference the client.
261
262   overriding function Get_Name_Expression
263    (Self : not null access constant UML_Data_Store_Node_Proxy)
264       return AMF.UML.String_Expressions.UML_String_Expression_Access;
265   --  Getter of NamedElement::nameExpression.
266   --
267   --  The string expression used to define the name of this named element.
268
269   overriding procedure Set_Name_Expression
270    (Self : not null access UML_Data_Store_Node_Proxy;
271     To   : AMF.UML.String_Expressions.UML_String_Expression_Access);
272   --  Setter of NamedElement::nameExpression.
273   --
274   --  The string expression used to define the name of this named element.
275
276   overriding function Get_Namespace
277    (Self : not null access constant UML_Data_Store_Node_Proxy)
278       return AMF.UML.Namespaces.UML_Namespace_Access;
279   --  Getter of NamedElement::namespace.
280   --
281   --  Specifies the namespace that owns the NamedElement.
282
283   overriding function Get_Qualified_Name
284    (Self : not null access constant UML_Data_Store_Node_Proxy)
285       return AMF.Optional_String;
286   --  Getter of NamedElement::qualifiedName.
287   --
288   --  A name which allows the NamedElement to be identified within a
289   --  hierarchy of nested Namespaces. It is constructed from the names of the
290   --  containing namespaces starting at the root of the hierarchy and ending
291   --  with the name of the NamedElement itself.
292
293   overriding function Get_Type
294    (Self : not null access constant UML_Data_Store_Node_Proxy)
295       return AMF.UML.Types.UML_Type_Access;
296   --  Getter of TypedElement::type.
297   --
298   --  The type of the TypedElement.
299   --  This information is derived from the return result for this Operation.
300
301   overriding procedure Set_Type
302    (Self : not null access UML_Data_Store_Node_Proxy;
303     To   : AMF.UML.Types.UML_Type_Access);
304   --  Setter of TypedElement::type.
305   --
306   --  The type of the TypedElement.
307   --  This information is derived from the return result for this Operation.
308
309   overriding function Is_Consistent_With
310    (Self : not null access constant UML_Data_Store_Node_Proxy;
311     Redefinee : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
312       return Boolean;
313   --  Operation RedefinableElement::isConsistentWith.
314   --
315   --  The query isConsistentWith() specifies, for any two RedefinableElements
316   --  in a context in which redefinition is possible, whether redefinition
317   --  would be logically consistent. By default, this is false; this
318   --  operation must be overridden for subclasses of RedefinableElement to
319   --  define the consistency conditions.
320
321   overriding function Is_Redefinition_Context_Valid
322    (Self : not null access constant UML_Data_Store_Node_Proxy;
323     Redefined : AMF.UML.Redefinable_Elements.UML_Redefinable_Element_Access)
324       return Boolean;
325   --  Operation RedefinableElement::isRedefinitionContextValid.
326   --
327   --  The query isRedefinitionContextValid() specifies whether the
328   --  redefinition contexts of this RedefinableElement are properly related
329   --  to the redefinition contexts of the specified RedefinableElement to
330   --  allow this element to redefine the other. By default at least one of
331   --  the redefinition contexts of this element must be a specialization of
332   --  at least one of the redefinition contexts of the specified element.
333
334   overriding function All_Owning_Packages
335    (Self : not null access constant UML_Data_Store_Node_Proxy)
336       return AMF.UML.Packages.Collections.Set_Of_UML_Package;
337   --  Operation NamedElement::allOwningPackages.
338   --
339   --  The query allOwningPackages() returns all the directly or indirectly
340   --  owning packages.
341
342   overriding function Is_Distinguishable_From
343    (Self : not null access constant UML_Data_Store_Node_Proxy;
344     N : AMF.UML.Named_Elements.UML_Named_Element_Access;
345     Ns : AMF.UML.Namespaces.UML_Namespace_Access)
346       return Boolean;
347   --  Operation NamedElement::isDistinguishableFrom.
348   --
349   --  The query isDistinguishableFrom() determines whether two NamedElements
350   --  may logically co-exist within a Namespace. By default, two named
351   --  elements are distinguishable if (a) they have unrelated types or (b)
352   --  they have related types but different names.
353
354   overriding function Namespace
355    (Self : not null access constant UML_Data_Store_Node_Proxy)
356       return AMF.UML.Namespaces.UML_Namespace_Access;
357   --  Operation NamedElement::namespace.
358   --
359   --  Missing derivation for NamedElement::/namespace : Namespace
360
361   overriding procedure Enter_Element
362    (Self    : not null access constant UML_Data_Store_Node_Proxy;
363     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
364     Control : in out AMF.Visitors.Traverse_Control);
365   --  Dispatch call to corresponding subprogram of visitor interface.
366
367   overriding procedure Leave_Element
368    (Self    : not null access constant UML_Data_Store_Node_Proxy;
369     Visitor : in out AMF.Visitors.Abstract_Visitor'Class;
370     Control : in out AMF.Visitors.Traverse_Control);
371   --  Dispatch call to corresponding subprogram of visitor interface.
372
373   overriding procedure Visit_Element
374    (Self     : not null access constant UML_Data_Store_Node_Proxy;
375     Iterator : in out AMF.Visitors.Abstract_Iterator'Class;
376     Visitor  : in out AMF.Visitors.Abstract_Visitor'Class;
377     Control  : in out AMF.Visitors.Traverse_Control);
378   --  Dispatch call to corresponding subprogram of iterator interface.
379
380end AMF.Internals.UML_Data_Store_Nodes;
381