models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaCapabilityType.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2020 Nordix Foundation.
   4  * Modifications Copyright (C) 2020-2021 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.tosca.simple.concepts;
  23
  24 import java.util.Collection;
  25 import java.util.LinkedHashMap;
  26 import java.util.LinkedHashSet;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Map.Entry;
  30 import java.util.Set;
  31 import javax.persistence.ElementCollection;
  32 import javax.persistence.Entity;
  33 import javax.persistence.Inheritance;
  34 import javax.persistence.InheritanceType;
  35 import javax.persistence.Lob;
  36 import javax.persistence.Table;
  37 import lombok.Data;
  38 import lombok.EqualsAndHashCode;
  39 import lombok.NonNull;
  40 import org.apache.commons.collections4.CollectionUtils;
  41 import org.onap.policy.common.parameters.BeanValidationResult;
  42 import org.onap.policy.common.parameters.annotations.NotNull;
  43 import org.onap.policy.common.parameters.annotations.Valid;
  44 import org.onap.policy.models.base.PfAuthorative;
  45 import org.onap.policy.models.base.PfConcept;
  46 import org.onap.policy.models.base.PfConceptKey;
  47 import org.onap.policy.models.base.PfKey;
  48 import org.onap.policy.models.base.PfReferenceKey;
  49 import org.onap.policy.models.base.PfUtils;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaCapabilityType;
  51 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
  52 import org.onap.policy.models.tosca.utils.ToscaUtils;
  53
  54 /**
  55  * Class to represent the capability type in TOSCA definition.
  56  */
  57
  58 @Entity
  59 @Table(name = "ToscaCapabilityType")
  60 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
  61 @Data
  62 @EqualsAndHashCode(callSuper = true)
  63 public class JpaToscaCapabilityType extends JpaToscaEntityType<ToscaCapabilityType>
  64         implements PfAuthorative<ToscaCapabilityType> {
  65     private static final long serialVersionUID = -563659852901842616L;
  66
  67     @ElementCollection
  68     @Lob
  69     private Map<@NotNull String, @NotNull @Valid JpaToscaProperty> properties;
  70
  71     /**
  72      * The Default Constructor creates a {@link JpaToscaCapabilityType} object with a null key.
  73      */
  74     public JpaToscaCapabilityType() {
  75         this(new PfConceptKey());
  76     }
  77
  78     /**
  79      * The Key Constructor creates a {@link JpaToscaCapabilityType} object with the given concept key.
  80      *
  81      * @param key the key
  82      */
  83     public JpaToscaCapabilityType(@NonNull final PfConceptKey key) {
  84         super(key);
  85     }
  86
  87     /**
  88      * Copy constructor.
  89      *
  90      * @param copyConcept the concept to copy from
  91      */
  92     public JpaToscaCapabilityType(final JpaToscaCapabilityType copyConcept) {
  93         super(copyConcept);
  94         this.properties = copyConcept.properties == null ? null : new LinkedHashMap<>(copyConcept.properties);
  95     }
  96
  97     /**
  98      * Authorative constructor.
  99      *
 100      * @param authorativeConcept the authorative concept to copy from
 101      */
 102     public JpaToscaCapabilityType(final ToscaCapabilityType authorativeConcept) {
 103         this.fromAuthorative(authorativeConcept);
 104     }
 105
 106     @Override
 107     public ToscaCapabilityType toAuthorative() {
 108         ToscaCapabilityType toscaCapabilityType = new ToscaCapabilityType();
 109         super.setToscaEntity(toscaCapabilityType);
 110         super.toAuthorative();
 111
 112         toscaCapabilityType.setProperties(PfUtils.mapMap(properties, JpaToscaProperty::toAuthorative));
 113
 114         return toscaCapabilityType;
 115     }
 116
 117     @Override
 118     public void fromAuthorative(final ToscaCapabilityType toscaCapabilityType) {
 119         super.fromAuthorative(toscaCapabilityType);
 120
 121         // Set properties
 122         if (toscaCapabilityType.getProperties() != null) {
 123             properties = new LinkedHashMap<>();
 124             for (Entry<String, ToscaProperty> toscaPropertyEntry : toscaCapabilityType.getProperties().entrySet()) {
 125                 JpaToscaProperty jpaProperty = new JpaToscaProperty(toscaPropertyEntry.getValue());
 126                 jpaProperty.setKey(new PfReferenceKey(getKey(), toscaPropertyEntry.getKey()));
 127                 properties.put(toscaPropertyEntry.getKey(), jpaProperty);
 128             }
 129         }
 130     }
 131
 132     @Override
 133     public List<PfKey> getKeys() {
 134         final List<PfKey> keyList = super.getKeys();
 135
 136         PfUtils.mapMap(properties, property -> keyList.addAll(property.getKeys()));
 137
 138
 139         if (properties != null) {
 140             for (JpaToscaProperty property : properties.values()) {
 141                 keyList.addAll(property.getKeys());
 142             }
 143         }
 144
 145         return keyList;
 146     }
 147
 148     @Override
 149     public void clean() {
 150         super.clean();
 151
 152         if (properties != null) {
 153             for (JpaToscaProperty property : properties.values()) {
 154                 property.clean();
 155             }
 156         }
 157     }
 158
 159     @Override
 160     public BeanValidationResult validate(@NonNull String fieldName) {
 161         BeanValidationResult result = super.validate(fieldName);
 162
 163         validateKeyVersionNotNull(result, "key", getKey());
 164
 165         return result;
 166     }
 167
 168     @Override
 169     public int compareTo(final PfConcept otherConcept) {
 170         if (otherConcept == null) {
 171             return -1;
 172         }
 173         if (this == otherConcept) {
 174             return 0;
 175         }
 176         if (getClass() != otherConcept.getClass()) {
 177             return getClass().getName().compareTo(otherConcept.getClass().getName());
 178         }
 179
 180         final JpaToscaCapabilityType other = (JpaToscaCapabilityType) otherConcept;
 181         int result = super.compareTo(other);
 182         if (result != 0) {
 183             return result;
 184         }
 185
 186         return PfUtils.compareMaps(properties, other.properties);
 187     }
 188
 189     /**
 190      * Get the data types referenced in a capability type.
 191      *
 192      * @return the data types referenced in a capability type
 193      */
 194     public Collection<PfConceptKey> getReferencedDataTypes() {
 195         if (properties == null) {
 196             return CollectionUtils.emptyCollection();
 197         }
 198
 199         Set<PfConceptKey> referencedDataTypes = new LinkedHashSet<>();
 200
 201         for (JpaToscaProperty property : properties.values()) {
 202             referencedDataTypes.add(property.getType());
 203
 204             if (property.getEntrySchema() != null) {
 205                 referencedDataTypes.add(property.getEntrySchema().getType());
 206             }
 207         }
 208
 209         referencedDataTypes.removeAll(ToscaUtils.getPredefinedDataTypes());
 210
 211         return referencedDataTypes;
 212     }
 213 }