models-base/src/main/java/org/onap/policy/models/base/PfSearchableKey.java

   1 /*
   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
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.base;
  23
  24 import javax.persistence.Column;
  25 import javax.persistence.Embeddable;
  26 import lombok.EqualsAndHashCode;
  27 import lombok.Getter;
  28 import lombok.NonNull;
  29 import org.onap.policy.common.utils.validation.Assertions;
  30
  31 /**
  32  * A key that is used to search for other concept keys. The name field may contain a
  33  * trailing ".*", to indicate wild-card matching.
  34  */
  35 @Embeddable
  36 @Getter
  37 @EqualsAndHashCode(callSuper = false)
  38 public class PfSearchableKey extends PfKeyImpl {
  39     private static final long serialVersionUID = 8932717618579392561L;
  40
  41     /** Regular expression to specify the structure of key names. */
  42     public static final String WILDCARD_NAME_REGEXP = "^[A-Za-z0-9\\-_\\.]+(?:\\.\\*)?$";
  43
  44     @Column(name = NAME_TOKEN, length = 120)
  45     private String name;
  46
  47     @Column(name = VERSION_TOKEN, length = 20)
  48     private String version;
  49
  50     /**
  51      * The default constructor creates a null key.
  52      */
  53     public PfSearchableKey() {
  54         this(NULL_KEY_NAME, NULL_KEY_VERSION);
  55     }
  56
  57     /**
  58      * Copy constructor.
  59      *
  60      * @param copyKey the key to copy from
  61      */
  62     public PfSearchableKey(final PfSearchableKey copyKey) {
  63         super(copyKey);
  64     }
  65
  66     /**
  67      * Constructor to create a key with the specified name and version.
  68      *
  69      * @param name the key name
  70      * @param version the key version
  71      */
  72     public PfSearchableKey(final String name, final String version) {
  73         super(name, version);
  74     }
  75
  76     /**
  77      * Constructor to create a key using the key and version from the specified key ID.
  78      *
  79      * @param id the key ID in a format that respects the KEY_ID_REGEXP
  80      */
  81     public PfSearchableKey(final String id) {
  82         super(id);
  83     }
  84
  85     public void setName(@NonNull final String name) {
  86         this.name = Assertions.validateStringParameter(NAME_TOKEN, name, getNameRegEx());
  87     }
  88
  89     public void setVersion(@NonNull final String version) {
  90         this.version = Assertions.validateStringParameter(VERSION_TOKEN, version, getVersionRegEx());
  91     }
  92
  93     /**
  94      * Get a null key.
  95      *
  96      * @return a null key
  97      */
  98     public static final PfSearchableKey getNullKey() {
  99         return new PfSearchableKey(PfKey.NULL_KEY_NAME, PfKey.NULL_KEY_VERSION);
 100     }
 101
 102     @Override
 103     protected String getNameRegEx() {
 104         return WILDCARD_NAME_REGEXP;
 105     }
 106
 107     @Override
 108     public String toString() {
 109         return "PfSearchableKey(name=" + getName() + ", version=" + getVersion() + ")";
 110     }
 111 }