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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2020 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.models.tosca.simple.concepts;
  22
  23 import java.util.Collection;
  24 import java.util.LinkedHashMap;
  25 import java.util.LinkedHashSet;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Map.Entry;
  29 import java.util.Set;
  30 import javax.persistence.ElementCollection;
  31 import javax.persistence.Entity;
  32 import javax.persistence.Inheritance;
  33 import javax.persistence.InheritanceType;
  34 import javax.persistence.Lob;
  35 import javax.persistence.Table;
  36 import lombok.Data;
  37 import lombok.EqualsAndHashCode;
  38 import lombok.NonNull;
  39 import org.apache.commons.collections4.CollectionUtils;
  40 import org.onap.policy.models.base.PfAuthorative;
  41 import org.onap.policy.models.base.PfConcept;
  42 import org.onap.policy.models.base.PfConceptKey;
  43 import org.onap.policy.models.base.PfKey;
  44 import org.onap.policy.models.base.PfReferenceKey;
  45 import org.onap.policy.models.base.PfUtils;
  46 import org.onap.policy.models.base.PfValidationMessage;
  47 import org.onap.policy.models.base.PfValidationResult;
  48 import org.onap.policy.models.base.PfValidationResult.ValidationResult;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaProperty;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaRelationshipType;
  51 import org.onap.policy.models.tosca.utils.ToscaUtils;
  52
  53 /**
  54  * Class to represent the relationship type in TOSCA definition.
  55  */
  56
  57 @Entity
  58 @Table(name = "ToscaRelationshipType")
  59 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
  60 @Data
  61 @EqualsAndHashCode(callSuper = true)
  62 public class JpaToscaRelationshipType extends JpaToscaEntityType<ToscaRelationshipType>
  63         implements PfAuthorative<ToscaRelationshipType> {
  64     private static final long serialVersionUID = -563659852901842616L;
  65
  66     @ElementCollection
  67     @Lob
  68     private Map<String, JpaToscaProperty> properties;
  69
  70     /**
  71      * The Default Constructor creates a {@link JpaToscaRelationshipType} object with a null key.
  72      */
  73     public JpaToscaRelationshipType() {
  74         this(new PfConceptKey());
  75     }
  76
  77     /**
  78      * The Key Constructor creates a {@link JpaToscaRelationshipType} object with the given concept key.
  79      *
  80      * @param key the key
  81      */
  82     public JpaToscaRelationshipType(@NonNull final PfConceptKey key) {
  83         super(key);
  84     }
  85
  86     /**
  87      * Copy constructor.
  88      *
  89      * @param copyConcept the concept to copy from
  90      */
  91     public JpaToscaRelationshipType(final JpaToscaRelationshipType copyConcept) {
  92         super(copyConcept);
  93         this.properties = PfUtils.mapMap(copyConcept.properties, JpaToscaProperty::new);
  94     }
  95
  96     /**
  97      * Authorative constructor.
  98      *
  99      * @param authorativeConcept the authorative concept to copy from
 100      */
 101     public JpaToscaRelationshipType(final ToscaRelationshipType authorativeConcept) {
 102         this.fromAuthorative(authorativeConcept);
 103     }
 104
 105     @Override
 106     public ToscaRelationshipType toAuthorative() {
 107         ToscaRelationshipType toscaRelationshipType = new ToscaRelationshipType();
 108         super.setToscaEntity(toscaRelationshipType);
 109         super.toAuthorative();
 110
 111         toscaRelationshipType.setProperties(PfUtils.mapMap(properties, JpaToscaProperty::toAuthorative));
 112
 113         return toscaRelationshipType;
 114     }
 115
 116     @Override
 117     public void fromAuthorative(final ToscaRelationshipType toscaRelationshipType) {
 118         super.fromAuthorative(toscaRelationshipType);
 119
 120         // Set properties
 121         if (toscaRelationshipType.getProperties() != null) {
 122             properties = new LinkedHashMap<>();
 123             for (Entry<String, ToscaProperty> toscaPropertyEntry : toscaRelationshipType.getProperties().entrySet()) {
 124                 JpaToscaProperty jpaProperty = new JpaToscaProperty(toscaPropertyEntry.getValue());
 125                 jpaProperty.setKey(new PfReferenceKey(getKey(), toscaPropertyEntry.getKey()));
 126                 properties.put(toscaPropertyEntry.getKey(), jpaProperty);
 127             }
 128         }
 129     }
 130
 131     @Override
 132     public List<PfKey> getKeys() {
 133         final List<PfKey> keyList = super.getKeys();
 134
 135         if (properties != null) {
 136             for (JpaToscaProperty property : properties.values()) {
 137                 keyList.addAll(property.getKeys());
 138             }
 139         }
 140
 141         return keyList;
 142     }
 143
 144     @Override
 145     public void clean() {
 146         super.clean();
 147
 148         if (properties != null) {
 149             for (JpaToscaProperty property : properties.values()) {
 150                 property.clean();
 151             }
 152         }
 153     }
 154
 155     @Override
 156     public PfValidationResult validate(@NonNull final PfValidationResult resultIn) {
 157         PfValidationResult result = super.validate(resultIn);
 158
 159         if (PfKey.NULL_KEY_VERSION.equals(getKey().getVersion())) {
 160             result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
 161                     "key version is a null version"));
 162         }
 163
 164         if (properties != null) {
 165             result = validateProperties(result);
 166         }
 167
 168         return result;
 169     }
 170
 171     /**
 172      * Validate the capabiltiy type properties.
 173      *
 174      * @param resultIn The result of validations up to now
 175      * @return the validation result
 176      */
 177     private PfValidationResult validateProperties(final PfValidationResult resultIn) {
 178         PfValidationResult result = resultIn;
 179
 180         for (JpaToscaProperty property : properties.values()) {
 181             if (property == null) {
 182                 result.addValidationMessage(new PfValidationMessage(getKey(), this.getClass(), ValidationResult.INVALID,
 183                         "relationship type property may not be null "));
 184             } else {
 185                 result = property.validate(result);
 186             }
 187         }
 188         return result;
 189     }
 190
 191     @Override
 192     public int compareTo(final PfConcept otherConcept) {
 193         if (otherConcept == null) {
 194             return -1;
 195         }
 196         if (this == otherConcept) {
 197             return 0;
 198         }
 199         if (getClass() != otherConcept.getClass()) {
 200             return getClass().getName().compareTo(otherConcept.getClass().getName());
 201         }
 202
 203         final JpaToscaRelationshipType other = (JpaToscaRelationshipType) otherConcept;
 204         int result = super.compareTo(other);
 205         if (result != 0) {
 206             return result;
 207         }
 208
 209         return PfUtils.compareMaps(properties, other.properties);
 210     }
 211
 212     /**
 213      * Get the data types referenced in a relationship type.
 214      *
 215      * @return the data types referenced in a relationship type
 216      */
 217     public Collection<PfConceptKey> getReferencedDataTypes() {
 218         if (properties == null) {
 219             return CollectionUtils.emptyCollection();
 220         }
 221
 222         Set<PfConceptKey> referencedDataTypes = new LinkedHashSet<>();
 223
 224         for (JpaToscaProperty property : properties.values()) {
 225             referencedDataTypes.add(property.getType());
 226
 227             if (property.getEntrySchema() != null) {
 228                 referencedDataTypes.add(property.getEntrySchema().getType());
 229             }
 230         }
 231
 232         referencedDataTypes.removeAll(ToscaUtils.getPredefinedDataTypes());
 233
 234         return referencedDataTypes;
 235     }
 236 }