2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019-2021, 2023 Nordix Foundation.
6 * Modifications Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.policy.models.base;
26 import jakarta.persistence.Column;
27 import jakarta.persistence.Embeddable;
28 import jakarta.persistence.Temporal;
29 import jakarta.persistence.TemporalType;
30 import java.io.Serial;
31 import java.time.Instant;
32 import java.util.Date;
34 import lombok.EqualsAndHashCode;
35 import lombok.NonNull;
36 import org.onap.policy.common.parameters.annotations.Pattern;
37 import org.onap.policy.common.utils.validation.Assertions;
41 @EqualsAndHashCode(callSuper = false)
42 public class PfTimestampKey extends PfKeyImpl {
44 private static final long serialVersionUID = -8410208962541783805L;
46 private static final String TIMESTAMP_TOKEN = "timeStamp";
48 @Column(name = NAME_TOKEN, length = 120)
49 @Pattern(regexp = NAME_REGEXP)
52 @Column(name = VERSION_TOKEN, length = 20)
53 @Pattern(regexp = VERSION_REGEXP)
54 private String version;
56 @Column(name = TIMESTAMP_TOKEN, precision = 3)
57 @Temporal(TemporalType.TIMESTAMP)
59 private Date timeStamp;
63 * The default constructor creates a null concept key.
65 public PfTimestampKey() {
66 this(NULL_KEY_NAME, NULL_KEY_VERSION, Instant.EPOCH);
72 * @param copyConcept the concept to copy from
74 public PfTimestampKey(@NonNull final PfTimestampKey copyConcept) {
76 this.timeStamp = copyConcept.getTimeStamp();
80 * Constructor to create a key with the specified name and version.
82 * @param name the key name
83 * @param version the key version
84 * @param instant the time stamp of key
86 public PfTimestampKey(@NonNull final String name, @NonNull final String version,
87 @NonNull final Instant instant) {
89 this.timeStamp = Date.from(instant);
93 * Constructor to create a key using the key and version from the specified key ID.
95 * @param id the key ID in a format that respects the KEY_ID_REGEXP
97 public PfTimestampKey(final String id) {
98 super(id.substring(0, id.lastIndexOf(':')));
99 this.timeStamp = new Date(Long.parseLong(id.substring(id.lastIndexOf(':') + 1)));
103 public String getId() {
104 return getName() + ':' + getVersion() + ':' + getTimeStamp().getTime();
112 public static PfTimestampKey getNullKey() {
113 return new PfTimestampKey(PfKey.NULL_KEY_NAME, PfKey.NULL_KEY_VERSION, Instant.EPOCH);
116 public Instant getInstant() {
117 return timeStamp.toInstant();
120 public void setInstant(final Instant instant) {
121 setTimeStamp(Date.from(instant));
125 public boolean isNewerThan(@NonNull PfKey otherKey) {
126 Assertions.instanceOf(otherKey, PfTimestampKey.class);
128 final PfTimestampKey otherConceptKey = (PfTimestampKey) otherKey;
130 if (this.equals(otherConceptKey)) {
134 if (!timeStamp.equals(otherConceptKey.timeStamp)) {
135 return timeStamp.after(otherConceptKey.timeStamp);
138 return super.isNewerThan(otherKey);
142 public boolean isNullKey() {
143 return super.isNullKey() && getTimeStamp().getTime() == 0;
147 public int compareTo(@NonNull final PfConcept otherObj) {
148 int result = super.compareTo(otherObj);
150 final PfTimestampKey other = (PfTimestampKey) otherObj;
151 return timeStamp.compareTo(other.timeStamp);
157 public void setName(@NonNull String name) {
158 this.name = Assertions.validateStringParameter(NAME_TOKEN, name, getNameRegEx());
162 public void setVersion(@NonNull String version) {
163 this.version = Assertions.validateStringParameter(VERSION_TOKEN, version, getVersionRegEx());