gerrit.onap Code Review - policy/clamp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022-2026 OpenInfra Foundation Europe. All rights reserved.
   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.clamp.models.acm.document.concepts;
  22
  23 import java.io.Serial;
  24 import java.util.Collection;
  25 import java.util.LinkedHashMap;
  26 import java.util.LinkedHashSet;
  27 import java.util.Map;
  28 import java.util.Set;
  29 import java.util.stream.Collectors;
  30 import lombok.Data;
  31 import lombok.EqualsAndHashCode;
  32 import lombok.NoArgsConstructor;
  33 import org.apache.commons.collections4.CollectionUtils;
  34 import org.onap.policy.clamp.models.acm.document.base.DocConceptKey;
  35 import org.onap.policy.clamp.models.acm.document.base.DocUtil;
  36 import org.onap.policy.common.parameters.annotations.NotBlank;
  37 import org.onap.policy.common.parameters.annotations.NotNull;
  38 import org.onap.policy.common.parameters.annotations.Valid;
  39 import org.onap.policy.models.base.PfUtils;
  40 import org.onap.policy.models.tosca.authorative.concepts.ToscaWithToscaProperties;
  41 import org.onap.policy.models.tosca.utils.ToscaUtils;
  42
  43 @Data
  44 @EqualsAndHashCode(callSuper = true)
  45 @NoArgsConstructor
  46 public class DocToscaWithToscaProperties<T extends ToscaWithToscaProperties> extends DocToscaEntity<T> {
  47
  48     @Serial
  49     private static final long serialVersionUID = 1L;
  50
  51     @SuppressWarnings("squid:S1948")
  52     private Map<@NotNull @NotBlank String, @NotNull @Valid DocToscaProperty> properties;
  53
  54     /**
  55      * Copy constructor.
  56      *
  57      * @param copyConcept the concept to copy from
  58      */
  59     public DocToscaWithToscaProperties(DocToscaWithToscaProperties<T> copyConcept) {
  60         super(copyConcept);
  61         this.properties = PfUtils.mapMap(copyConcept.properties, DocToscaProperty::new);
  62     }
  63
  64     @Override
  65     public T toAuthorative() {
  66         var tosca = super.toAuthorative();
  67         tosca.setProperties(PfUtils.mapMap(properties, DocToscaProperty::toAuthorative));
  68         return tosca;
  69     }
  70
  71     @Override
  72     public void fromAuthorative(T authorativeConcept) {
  73         super.fromAuthorative(authorativeConcept);
  74
  75         // Set properties
  76         if (authorativeConcept.getProperties() != null) {
  77             properties = new LinkedHashMap<>();
  78             for (var toscaPropertyEntry : authorativeConcept.getProperties().entrySet()) {
  79                 var jpaProperty = new DocToscaProperty(toscaPropertyEntry.getValue());
  80                 jpaProperty.setName(toscaPropertyEntry.getKey());
  81                 properties.put(toscaPropertyEntry.getKey(), jpaProperty);
  82             }
  83         }
  84     }
  85
  86     /**
  87      * Get the referenced data types.
  88      *
  89      * @return the referenced data types
  90      */
  91     public Collection<DocConceptKey> getReferencedDataTypes() {
  92         if (properties == null) {
  93             return CollectionUtils.emptyCollection();
  94         }
  95
  96         Set<DocConceptKey> referencedDataTypes = new LinkedHashSet<>();
  97
  98         for (var property : properties.values()) {
  99             referencedDataTypes.add(property.getTypeDocConceptKey());
 100
 101             if (property.getEntrySchema() != null) {
 102                 referencedDataTypes.add(property.getEntrySchema().getTypeDocConceptKey());
 103             }
 104         }
 105
 106         var set = ToscaUtils.getPredefinedDataTypes().stream().map(DocConceptKey::new).collect(Collectors.toSet());
 107         referencedDataTypes.removeAll(set);
 108         return referencedDataTypes;
 109     }
 110
 111     @Override
 112     public int compareTo(final DocToscaEntity<T> otherConcept) {
 113         int result = super.compareTo(otherConcept);
 114         if (result != 0) {
 115             return result;
 116         }
 117
 118         final var other = (DocToscaWithToscaProperties<T>) otherConcept;
 119
 120         return DocUtil.compareMaps(properties, other.properties);
 121     }
 122 }