2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.base;
24 import javax.persistence.Column;
25 import javax.persistence.Embeddable;
26 import lombok.EqualsAndHashCode;
28 import lombok.NonNull;
29 import org.onap.policy.common.parameters.annotations.Pattern;
30 import org.onap.policy.common.utils.validation.Assertions;
33 * A key that is used to search for other concept keys. The name field may contain a
34 * trailing ".*", to indicate wild-card matching.
38 @EqualsAndHashCode(callSuper = false)
39 public class PfSearchableKey extends PfKeyImpl {
40 private static final long serialVersionUID = 8932717618579392561L;
42 /** Regular expression to specify the structure of key names. */
43 public static final String WILDCARD_NAME_REGEXP = "^[A-Za-z0-9\\-_\\.]+(?:\\.\\*)?$";
45 @Column(name = NAME_TOKEN, length = 120)
46 @Pattern(regexp = NAME_REGEXP)
49 @Column(name = VERSION_TOKEN, length = 20)
50 @Pattern(regexp = VERSION_REGEXP)
51 private String version;
54 * The default constructor creates a null key.
56 public PfSearchableKey() {
57 this(NULL_KEY_NAME, NULL_KEY_VERSION);
63 * @param copyKey the key to copy from
65 public PfSearchableKey(final PfSearchableKey copyKey) {
70 * Constructor to create a key with the specified name and version.
72 * @param name the key name
73 * @param version the key version
75 public PfSearchableKey(final String name, final String version) {
80 * Constructor to create a key using the key and version from the specified key ID.
82 * @param id the key ID in a format that respects the KEY_ID_REGEXP
84 public PfSearchableKey(final String id) {
88 public void setName(@NonNull final String name) {
89 this.name = Assertions.validateStringParameter(NAME_TOKEN, name, getNameRegEx());
92 public void setVersion(@NonNull final String version) {
93 this.version = Assertions.validateStringParameter(VERSION_TOKEN, version, getVersionRegEx());
101 public static final PfSearchableKey getNullKey() {
102 return new PfSearchableKey(PfKey.NULL_KEY_NAME, PfKey.NULL_KEY_VERSION);
106 protected String getNameRegEx() {
107 return WILDCARD_NAME_REGEXP;
111 public String toString() {
112 return "PfSearchableKey(name=" + getName() + ", version=" + getVersion() + ")";