summaryrefslogtreecommitdiffstats
path: root/docs/ONAP Model Spec/im/Common/SelectionCriteria.rst
blob: 5452faa662f47048d968fe7136510c0001a7ef23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
.. Copyright 2020
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

Selection Criteria Model
========================

Diagrams
--------

SelectionCriteria 
~~~~~~~~~~~~~~~~~~

.. image:: SelectionCriteria.png

Classes
-------

.. _selectioncriteria-1:

SelectionCriteria
~~~~~~~~~~~~~~~~~

SelectionCriteria finds descriptors and instances according to specific properties of those entities.

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

=================== ========== ========= ================================== =============================================
**Attribute Name**  **Type**   **Mult.** **Stereotypes**                    **Description**
SelectionCriteriaId Identifier 1         Preliminary                        Unique indentifier of this SelectionCriteria.
                                                                           
                                         OpenModelAttribute                
                                                                           
                                         -  isInvariant: false             
                                                                           
                                         -  valueRange: no range constraint
                                                                           
                                         -  support: MANDATORY             
=================== ========== ========= ================================== =============================================

SelectionCriteriaAtomic
~~~~~~~~~~~~~~~~~~~~~~~

A simple (atomic) selection criteria that holds a specific attribute comparision expression.

**Parent class:** SelectionCriteria

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

=================== ========== ========= ================================== ==================================================================
**Attribute Name**  **Type**   **Mult.** **Stereotypes**                    **Description**
metricName          String     1         Preliminary                        Name of compared parameter or attribute.
                                                                           
                                         OpenModelAttribute                 Name of compared parameter or attribute.
                                                                           
                                         -  isInvariant: false             
                                                                           
                                         -  valueRange: no range constraint
                                                                           
                                         -  support: MANDATORY             
operator            Operator   1         Preliminary                        Comparison operator, e.g. equal, less than, greater or etc.
                                                                           
                                         OpenModelAttribute                
                                                                           
                                         -  isInvariant: false             
                                                                           
                                         -  valueRange: no range constraint
                                                                           
                                         -  support: MANDATORY             
value               String     1         Preliminary                        Compared value (can be a name of a parameter in referenced class).
                                                                           
                                         OpenModelAttribute                
                                                                           
                                         -  isInvariant: false             
                                                                           
                                         -  valueRange: no range constraint
                                                                           
                                         -  support: MANDATORY             
valueType           String     1         Preliminary                        The type of the value property (String, Integer, Real, ...).
                                                                           
                                         OpenModelAttribute                
                                                                           
                                         -  isInvariant: false             
                                                                           
                                         -  valueRange: no range constraint
                                                                           
                                         -  support: MANDATORY             
SelectionCriteriaId Identifier 1         Preliminary                        Unique indentifier of this SelectionCriteria.
                                                                           
                                         OpenModelAttribute                
                                                                           
                                         -  isInvariant: false             
                                                                           
                                         -  valueRange: no range constraint
                                                                           
                                         -  support: MANDATORY             
=================== ========== ========= ================================== ==================================================================

SelectionCriteriaComposite
~~~~~~~~~~~~~~~~~~~~~~~~~~

A SelectionCriteria that is an aggregation of multiple selection criterias. Agregation can be for example AND, OR, or XOR logical operations.

**Parent class:** SelectionCriteria

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

=================== ================= ========= ================================== =====================================================================
**Attribute Name**  **Type**          **Mult.** **Stereotypes**                    **Description**
compositeOperator   CompositeOperator 1         Preliminary                        Logical operation for filters composition, e.g. logical AND, OR, XOR.
                                                                                  
                                                OpenModelAttribute                
                                                                                  
                                                -  isInvariant: false             
                                                                                  
                                                -  valueRange: no range constraint
                                                                                  
                                                -  support: MANDATORY             
SelectionCriteriaId Identifier        1         Preliminary                        Unique indentifier of this SelectionCriteria.
                                                                                  
                                                OpenModelAttribute                
                                                                                  
                                                -  isInvariant: false             
                                                                                  
                                                -  valueRange: no range constraint
                                                                                  
                                                -  support: MANDATORY             
=================== ================= ========= ================================== =====================================================================

Associations
------------

DesignEntityHasSelectionCriteria
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

-  Preliminary

================== =========== ========== ========= ================= =============== =====================
**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type**          **Description** **Stereotypes**
designentity       none        Not navig. 0..\*     DesignEntity                      OpenModelAttribute
                                                                                     
                                                                                      -  partOfObjectKey: 0
                                                                                     
                                                                                      -  uniqueSet:
                                                                                     
                                                                                      -  isInvariant: false
                                                                                     
                                                                                      -  unsigned: false
                                                                                     
                                                                                      -  counter: NA
                                                                                     
                                                                                      -  support: MANDATORY
selectioncriteria  none        Not navig. 0..\*     SelectionCriteria                 OpenModelAttribute
                                                                                     
                                                                                      -  partOfObjectKey: 0
                                                                                     
                                                                                      -  uniqueSet:
                                                                                     
                                                                                      -  isInvariant: false
                                                                                     
                                                                                      -  unsigned: false
                                                                                     
                                                                                      -  counter: NA
                                                                                     
                                                                                      -  support: MANDATORY
================== =========== ========== ========= ================= =============== =====================

SelectionCriteriaCompositeComprisedOfSelectionCriteria
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

-  Preliminary

========================== =========== ========== ========= ========================== =============== =====================
**Attribute Name**         **Aggreg.** **Navig.** **Mult.** **Type**                   **Description** **Stereotypes**
selectioncriteria          shared      Not navig. 2..\*     SelectionCriteria                          OpenModelAttribute
                                                                                                      
                                                                                                       -  partOfObjectKey: 0
                                                                                                      
                                                                                                       -  uniqueSet:
                                                                                                      
                                                                                                       -  isInvariant: false
                                                                                                      
                                                                                                       -  unsigned: false
                                                                                                      
                                                                                                       -  counter: NA
                                                                                                      
                                                                                                       -  support: MANDATORY
selectioncriteriacomposite none        Not navig. 0..\*     SelectionCriteriaComposite                 OpenModelAttribute
                                                                                                      
                                                                                                       -  partOfObjectKey: 0
                                                                                                      
                                                                                                       -  uniqueSet:
                                                                                                      
                                                                                                       -  isInvariant: false
                                                                                                      
                                                                                                       -  unsigned: false
                                                                                                      
                                                                                                       -  counter: NA
                                                                                                      
                                                                                                       -  support: MANDATORY
========================== =========== ========== ========= ========================== =============== =====================

Enumerations
------------

CompositeOperator
~~~~~~~~~~~~~~~~~

The operator being applied to to some group of selectoin critiera.

Contains Enumeration Literals:

-  AND:

-  OR:

-  XOR:

Operator
~~~~~~~~

The operator being applied to some atomic selection critera.

Contains Enumeration Literals:

-  MORETHAN:

-  LESSTHAN:

-  EQUAL: