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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021 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.models.base;
import javax.persistence.Column;
import javax.persistence.Embeddable;
import javax.persistence.GeneratedValue;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import org.onap.policy.common.parameters.annotations.Pattern;
import org.onap.policy.common.utils.validation.Assertions;
/**
* A concept key uniquely identifies every first order entity in the system. Every first order concept in the system
* must have a {@link PfGeneratedIdKey} to identify it. Concepts that are wholly contained in another concept are
* identified using a {@link PfReferenceKey} key.
*
* <p/>Key validation checks that the name and version fields match the NAME_REGEXP and VERSION_REGEXP
* regular expressions respectively.
*/
@Embeddable
@Data
@EqualsAndHashCode(callSuper = false)
public class PfGeneratedIdKey extends PfKeyImpl {
private static final long serialVersionUID = 1L;
private static final String ID_TOKEN = "ID";
@Column(name = NAME_TOKEN, length = 120)
@Pattern(regexp = NAME_REGEXP)
private String name;
@Column(name = VERSION_TOKEN, length = 20)
@Pattern(regexp = VERSION_REGEXP)
private String version;
@Column(name = ID_TOKEN)
@GeneratedValue
private Long generatedId;
/**
* The default constructor creates a null concept key.
*/
public PfGeneratedIdKey() {
this(NULL_KEY_NAME, NULL_KEY_VERSION);
}
/**
* Constructor to create a key with the specified name and version.
*
* @param name the key name
* @param version the key version
*/
public PfGeneratedIdKey(final String name, final String version) {
super(name, version);
}
/**
* Copy constructor.
*
* @param copyConcept the concept to copy from
*/
public PfGeneratedIdKey(final PfGeneratedIdKey copyConcept) {
super(copyConcept);
this.generatedId = copyConcept.getGeneratedId();
}
/**
* Constructor to create a key with the specified name and version.
*
* @param name the key name
* @param version the key version
* @param generatedId the conceptId of key
*/
public PfGeneratedIdKey(@NonNull final String name, @NonNull final String version,
final Long generatedId) {
super(name, version);
this.generatedId = generatedId;
}
/**
* Constructor to create a key using the key and version from the specified key ID.
*
* @param id the key ID in a format that respects the KEY_ID_REGEXP
*/
public PfGeneratedIdKey(final String id) {
super(id.substring(0, id.lastIndexOf(':')));
this.generatedId = Long.parseLong(id.substring(id.lastIndexOf(':') + 1));
}
@Override
public int compareTo(@NonNull final PfConcept otherObj) {
int result = super.compareTo(otherObj);
if (0 == result) {
final PfGeneratedIdKey other = (PfGeneratedIdKey) otherObj;
return generatedId.compareTo(other.generatedId);
}
return result;
}
@Override
public String getId() {
return getName() + ':' + getVersion() + ':' + getGeneratedId();
}
@Override
public boolean isNewerThan(@NonNull PfKey otherKey) {
Assertions.instanceOf(otherKey, PfGeneratedIdKey.class);
final PfGeneratedIdKey otherConceptKey = (PfGeneratedIdKey) otherKey;
if (this.equals(otherConceptKey)) {
return false;
}
if (!generatedId.equals(otherConceptKey.generatedId)) {
return generatedId.compareTo(otherConceptKey.generatedId) >= 1;
}
return super.isNewerThan(otherKey);
}
@Override
public boolean isNullKey() {
return super.isNullKey() && getGeneratedId() == null;
}
public void setName(@NonNull final String name) {
this.name = Assertions.validateStringParameter(NAME_TOKEN, name, getNameRegEx());
}
public void setVersion(@NonNull final String version) {
this.version = Assertions.validateStringParameter(VERSION_TOKEN, version, getVersionRegEx());
}
/**
* Get a null concept key.
*
* @return a null concept key
*/
public static final PfGeneratedIdKey getNullKey() {
return new PfGeneratedIdKey(PfKey.NULL_KEY_NAME, PfKey.NULL_KEY_VERSION);
}
}
|
