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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. All rights reserved.
* Modifications Copyright (C) 2019 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.apex.model.eventmodel.concepts;
import java.util.List;
import javax.persistence.AttributeOverride;
import javax.persistence.AttributeOverrides;
import javax.persistence.Column;
import javax.persistence.Embedded;
import javax.persistence.EmbeddedId;
import javax.persistence.Entity;
import javax.persistence.Inheritance;
import javax.persistence.InheritanceType;
import javax.persistence.Table;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxConcept;
import org.onap.policy.apex.model.basicmodel.concepts.AxKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxKeyUse;
import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationMessage;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult.ValidationResult;
import org.onap.policy.apex.model.basicmodel.xml.AxReferenceKeyAdapter;
import org.onap.policy.common.utils.validation.Assertions;
/**
* In Apex, a field is an input or output parameter to or from a concept. For example, the parameters of an event are
* fields and the input and output of a task is defined as a collection of fields.
*
* <p>A field has an {@link AxReferenceKey} key that defines its name and parent, and a {@link AxArtifactKey} key to a
* context schema that defines the structure of the data atom that holds the value of the field. Fields can be specified
* as being optional but are mandatory by default.
*
* <p>Validation checks that the field key and the field schema reference key are not null.
*/
@Entity
@Table(name = "AxField")
@Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "apexField", namespace = "http://www.onap.org/policy/apex-pdp")
@XmlType(name = "AxField", namespace = "http://www.onap.org/policy/apex-pdp", propOrder =
{ "key", "fieldSchemaKey", "optional" })
public class AxField extends AxConcept {
private static final String KEY_MAY_NOT_BE_NULL = "key may not be null";
private static final String FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL = "fieldSchemaKey may not be null";
private static final long serialVersionUID = -6443016863162692288L;
private static final int HASH_PRIME_0 = 1231;
private static final int HASH_PRIME_1 = 1237;
@EmbeddedId()
@XmlElement(name = "key", required = true)
@XmlJavaTypeAdapter(AxReferenceKeyAdapter.class)
private AxReferenceKey key;
// @formatter:off
@Embedded
@AttributeOverrides({ @AttributeOverride(name = "name", column = @Column(name = "fieldSchemaName")),
@AttributeOverride(name = "version", column = @Column(name = "fieldSchemaVersion")) })
@Column(name = "fieldSchemaKey")
@XmlElement(required = true)
private AxArtifactKey fieldSchemaKey;
// @formatter:on
@Column(name = "optional")
@XmlElement(required = false)
private boolean optional;
/**
* The default constructor creates a field with a null artifact and schema key.
*/
public AxField() {
this(new AxReferenceKey());
optional = false;
}
/**
* The default constructor creates a field with the given artifact key and a null schema key.
*
* @param key the field key
*/
public AxField(final AxReferenceKey key) {
this(key, new AxArtifactKey());
}
/**
* Copy constructor.
*
* @param copyConcept the concept to copy from
*/
public AxField(final AxField copyConcept) {
super(copyConcept);
}
/**
* Constructor to create the field with both its keys defined.
*
* @param key the field key
* @param fieldSchemaKey the key of the field schema to use for this field
*/
public AxField(final AxReferenceKey key, final AxArtifactKey fieldSchemaKey) {
super();
Assertions.argumentNotNull(key, KEY_MAY_NOT_BE_NULL);
Assertions.argumentNotNull(fieldSchemaKey, FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL);
this.key = key;
this.fieldSchemaKey = fieldSchemaKey;
}
/**
* Constructor to create the field with all its fields defined.
*
* @param key the field key
* @param fieldSchemaKey the key of the field schema to use for this field
* @param optional true if this field is optional
*/
public AxField(final AxReferenceKey key, final AxArtifactKey fieldSchemaKey, final boolean optional) {
super();
Assertions.argumentNotNull(key, KEY_MAY_NOT_BE_NULL);
Assertions.argumentNotNull(fieldSchemaKey, FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL);
this.key = key;
this.fieldSchemaKey = fieldSchemaKey;
this.optional = optional;
}
/**
* Constructor to create the field with the local name of its reference key defined and its schema key defined.
*
* @param localName the local name of the field reference key
* @param fieldSchemaKey the key of the field schema to use for this field
*/
public AxField(final String localName, final AxArtifactKey fieldSchemaKey) {
super();
Assertions.argumentNotNull(localName, "localName may not be null");
Assertions.argumentNotNull(fieldSchemaKey, FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL);
key = new AxReferenceKey();
key.setLocalName(localName);
this.fieldSchemaKey = fieldSchemaKey;
}
/**
* Constructor to create the field with the local name of its reference key defined, its schema key and optionality
* defined.
*
* @param localName the local name of the field reference key
* @param fieldSchemaKey the key of the field schema to use for this field
* @param optional true if this field is optional
*/
public AxField(final String localName, final AxArtifactKey fieldSchemaKey, final boolean optional) {
super();
Assertions.argumentNotNull(localName, "localName may not be null");
Assertions.argumentNotNull(fieldSchemaKey, FIELD_SCHEMA_KEY_MAY_NOT_BE_NULL);
key = new AxReferenceKey();
key.setLocalName(localName);
this.fieldSchemaKey = fieldSchemaKey;
this.optional = optional;
}
/**
* {@inheritDoc}.
*/
@Override
public AxReferenceKey getKey() {
return key;
}
/**
* {@inheritDoc}.
*/
@Override
public List<AxKey> getKeys() {
final List<AxKey> keyList = key.getKeys();
keyList.add(new AxKeyUse(fieldSchemaKey));
return keyList;
}
/**
* Sets the reference key of the field.
*
* @param key the field reference key
*/
public void setKey(final AxReferenceKey key) {
Assertions.argumentNotNull(key, KEY_MAY_NOT_BE_NULL);
this.key = key;
}
/**
* Gets the key of the field schema.
*
* @return the field schema key
*/
public AxArtifactKey getSchema() {
return fieldSchemaKey;
}
/**
* Sets the key of the field schema.
*
* @param schema the field schema key
*/
public void setSchema(final AxArtifactKey schema) {
Assertions.argumentNotNull(schema, "schema may not be null");
this.fieldSchemaKey = schema;
}
/**
* Gets the optionality of the field.
*
* @return the field optional flag
*/
public boolean getOptional() {
return optional;
}
/**
* Sets the optionality of the field.
*
* @param optional the optionality of the field
*/
public void setOptional(final boolean optional) {
this.optional = optional;
}
/**
* {@inheritDoc}.
*/
@Override
public AxValidationResult validate(final AxValidationResult resultIn) {
AxValidationResult result = resultIn;
if (key.equals(AxReferenceKey.getNullKey())) {
result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
"key is a null key"));
}
result = key.validate(result);
if (fieldSchemaKey.equals(AxArtifactKey.getNullKey())) {
result.addValidationMessage(new AxValidationMessage(key, this.getClass(), ValidationResult.INVALID,
"fieldSchemaKey is a null key: " + fieldSchemaKey));
}
return fieldSchemaKey.validate(result);
}
/**
* {@inheritDoc}.
*/
@Override
public void clean() {
key.clean();
fieldSchemaKey.clean();
}
/**
* {@inheritDoc}.
*/
@Override
public String toString() {
final StringBuilder builder = new StringBuilder();
builder.append(this.getClass().getSimpleName());
builder.append(":(");
builder.append("key=");
builder.append(key);
builder.append(",fieldSchemaKey=");
builder.append(fieldSchemaKey);
builder.append(",optional=");
builder.append(optional);
builder.append(")");
return builder.toString();
}
/**
* {@inheritDoc}.
*/
@Override
public AxConcept copyTo(final AxConcept targetObject) {
Assertions.argumentNotNull(targetObject, "target may not be null");
final Object copyObject = targetObject;
Assertions.instanceOf(copyObject, AxField.class);
final AxField copy = ((AxField) copyObject);
copy.setKey(new AxReferenceKey(key));
copy.setSchema(new AxArtifactKey(fieldSchemaKey));
copy.setOptional(optional);
return copy;
}
/**
* {@inheritDoc}.
*/
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + key.hashCode();
result = prime * result + fieldSchemaKey.hashCode();
result = prime * result + (optional ? HASH_PRIME_0 : HASH_PRIME_1);
return result;
}
/*
* (nonJavadoc)
*
* @see org.onap.policy.apex.model.basicmodel.concepts.AxConcept#equals(java.lang.Object)
*/
@Override
public boolean equals(final Object obj) {
if (obj == null) {
return false;
}
if (this == obj) {
return true;
}
if (!(obj instanceof AxField)) {
return false;
}
final AxField other = (AxField) obj;
if (!key.getLocalName().equals(other.key.getLocalName())) {
return false;
}
if (optional != other.optional) {
return false;
}
return fieldSchemaKey.equals(other.fieldSchemaKey);
}
/**
* {@inheritDoc}.
*/
@Override
public int compareTo(final AxConcept otherObj) {
if (otherObj == null) {
return 1;
}
if (this == otherObj) {
return 0;
}
if (!(otherObj instanceof AxField)) {
return this.hashCode() - otherObj.hashCode();
}
final AxField other = (AxField) otherObj;
if (!key.getLocalName().equals(other.key.getLocalName())) {
return key.getLocalName().compareTo(other.key.getLocalName());
}
if (optional != other.optional) {
return (optional ? 1 : -1);
}
return fieldSchemaKey.compareTo(other.fieldSchemaKey);
}
}
|