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
|
/*-
* ============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 java.time.Instant;
import javax.persistence.Column;
import javax.persistence.Embeddable;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import lombok.ToString;
import org.onap.policy.common.parameters.annotations.NotNull;
import org.onap.policy.common.utils.validation.Assertions;
/**
* This class is an extension of PfReferenceKey. It has similar behaviour as of PfReferenceKey with an
* additional option to have timestamp as a parameter.
*
*/
@Embeddable
@Data
@EqualsAndHashCode
@ToString(callSuper = true)
public class PfReferenceTimestampKey extends PfReferenceKey {
private static final String TIMESTAMP_TOKEN = "timeStamp";
private static final Instant DEFAULT_TIMESTAMP = Instant.EPOCH;
@Column(name = TIMESTAMP_TOKEN)
@NotNull
private Instant timeStamp;
/**
* The default constructor creates a null reference timestamp key.
*/
public PfReferenceTimestampKey() {
super();
this.timeStamp = DEFAULT_TIMESTAMP;
}
/**
* The Copy Constructor creates a key by copying another key.
*
* @param referenceKey
* the reference key to copy from
*/
public PfReferenceTimestampKey(final PfReferenceTimestampKey referenceKey) {
super(referenceKey);
this.timeStamp = referenceKey.getTimeStamp();
}
/**
* Constructor to create a null reference key for the specified parent concept key.
*
* @param pfConceptKey
* the parent concept key of this reference key
*/
public PfReferenceTimestampKey(final PfConceptKey pfConceptKey) {
super(pfConceptKey);
this.timeStamp = DEFAULT_TIMESTAMP;
}
/**
* Constructor to create a reference timestamp key for the given parent concept key with the given local name.
*
* @param pfConceptKey
* the parent concept key of this reference key
* @param localName
* the local name of this reference key
* @param timeStamp
* the timestamp for this reference key
*/
public PfReferenceTimestampKey(final PfConceptKey pfConceptKey, final String localName, final Instant timeStamp) {
super(pfConceptKey, localName);
this.timeStamp = timeStamp;
}
/**
* Constructor to create a reference timestamp key for the given parent reference key with the given local name.
*
* @param parentReferenceKey
* the parent reference key of this reference key
* @param localName
* the local name of this reference key
* @param timeStamp
* the timestamp for this reference key
*/
public PfReferenceTimestampKey(final PfReferenceKey parentReferenceKey, final String localName,
final Instant timeStamp) {
super(parentReferenceKey, localName);
this.timeStamp = timeStamp;
}
/**
* Constructor to create a reference timestamp key for the given parent reference key (specified by the parent
* reference key's concept key and local name) with the given local name.
*
* @param pfConceptKey
* the concept key of the parent reference key of this reference key
* @param parentLocalName
* the local name of the parent reference key of this reference key
* @param localName
* the local name of this reference key
* @param timeStamp
* the timestamp for this reference key
*/
public PfReferenceTimestampKey(final PfConceptKey pfConceptKey, final String parentLocalName,
final String localName, final Instant timeStamp) {
super(pfConceptKey, parentLocalName, localName);
this.timeStamp = timeStamp;
}
/**
* Constructor to create a reference timestamp key for the given parent concept key (specified by the
* parent concept key's name and version) with the given local name.
*
* @param parentKeyName
* the name of the parent concept key of this reference key
* @param parentKeyVersion
* the version of the parent concept key of this reference key
* @param localName
* the local name of this reference key
* @param timeStamp
* the timestamp for this reference key
*/
public PfReferenceTimestampKey(final String parentKeyName, final String parentKeyVersion, final String localName,
final Instant timeStamp) {
super(parentKeyName, parentKeyVersion, NULL_KEY_NAME, localName);
this.timeStamp = timeStamp;
}
/**
* Constructor to create a reference timestamp key for the given parent key (specified by the parent key's name,
* version and local name) with the given local name.
*
* @param parentKeyName
* the parent key name of this reference key
* @param parentKeyVersion
* the parent key version of this reference key
* @param parentLocalName
* the parent local name of this reference key
* @param localName
* the local name of this reference key
* @param timeStamp
* the timestamp for this reference key
*/
public PfReferenceTimestampKey(final String parentKeyName, final String parentKeyVersion,
final String parentLocalName, final String localName, final Instant timeStamp) {
super(parentKeyName, parentKeyVersion, parentLocalName, localName);
this.timeStamp = timeStamp;
}
/**
* 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 PfReferenceTimestampKey(final String id) {
super(id.substring(0, id.lastIndexOf(':')));
this.timeStamp = Instant.ofEpochSecond(Long.parseLong(id.substring(id.lastIndexOf(':') + 1)));
}
/**
* Get a null reference timestamp key.
*
* @return a null reference key
*/
public static PfReferenceTimestampKey getNullKey() {
return new PfReferenceTimestampKey(PfKey.NULL_KEY_NAME, PfKey.NULL_KEY_VERSION, PfKey.NULL_KEY_NAME,
PfKey.NULL_KEY_NAME, DEFAULT_TIMESTAMP);
}
@Override
public PfReferenceTimestampKey getKey() {
return this;
}
@Override
public String getId() {
return super.getId() + ':' + getTimeStamp().getEpochSecond();
}
@Override
public boolean isNullKey() {
return super.isNullKey() && getTimeStamp().getEpochSecond() == 0;
}
@Override
public boolean isNewerThan(@NonNull PfKey otherKey) {
Assertions.instanceOf(otherKey, PfReferenceTimestampKey.class);
final PfReferenceTimestampKey otherConceptKey = (PfReferenceTimestampKey) otherKey;
if (this.equals(otherConceptKey)) {
return false;
}
if (!getTimeStamp().equals(otherConceptKey.timeStamp)) {
return timeStamp.isAfter(otherConceptKey.timeStamp);
}
return super.isNewerThan(otherKey);
}
}
|
