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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 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.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 lombok.NonNull;
  34 import org.apache.commons.collections4.CollectionUtils;
  35 import org.onap.policy.clamp.models.acm.document.base.DocConceptKey;
  36 import org.onap.policy.common.parameters.BeanValidationResult;
  37 import org.onap.policy.common.parameters.annotations.NotBlank;
  38 import org.onap.policy.common.parameters.annotations.NotNull;
  39 import org.onap.policy.common.parameters.annotations.Valid;
  40 import org.onap.policy.models.base.PfUtils;
  41 import org.onap.policy.models.tosca.authorative.concepts.ToscaWithToscaProperties;
  42 import org.onap.policy.models.tosca.utils.ToscaUtils;
  43
  44 @Data
  45 @EqualsAndHashCode(callSuper = true)
  46 @NoArgsConstructor
  47 public class DocToscaWithToscaProperties<T extends ToscaWithToscaProperties> extends DocToscaEntity<T> {
  48
  49     @Serial
  50     private static final long serialVersionUID = 1L;
  51
  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     /**
  72      * Validates the fields of the object, including its key.
  73      *
  74      * @param fieldName name of the field containing this
  75      * @return the result, or {@code null}
  76      */
  77     protected BeanValidationResult validateWithKey(@NonNull String fieldName) {
  78         var result = super.validate(fieldName);
  79
  80         validateKeyVersionNotNull(result, "key", getConceptKey());
  81
  82         return result;
  83     }
  84
  85     @Override
  86     public void fromAuthorative(T authorativeConcept) {
  87         super.fromAuthorative(authorativeConcept);
  88
  89         // Set properties
  90         if (authorativeConcept.getProperties() != null) {
  91             properties = new LinkedHashMap<>();
  92             for (var toscaPropertyEntry : authorativeConcept.getProperties().entrySet()) {
  93                 var jpaProperty = new DocToscaProperty(toscaPropertyEntry.getValue());
  94                 jpaProperty.setName(toscaPropertyEntry.getKey());
  95                 properties.put(toscaPropertyEntry.getKey(), jpaProperty);
  96             }
  97         }
  98     }
  99
 100     /**
 101      * Get the referenced data types.
 102      *
 103      * @return the referenced data types
 104      */
 105     public Collection<DocConceptKey> getReferencedDataTypes() {
 106         if (properties == null) {
 107             return CollectionUtils.emptyCollection();
 108         }
 109
 110         Set<DocConceptKey> referencedDataTypes = new LinkedHashSet<>();
 111
 112         for (var property : properties.values()) {
 113             referencedDataTypes.add(property.getTypeDocConceptKey());
 114
 115             if (property.getEntrySchema() != null) {
 116                 referencedDataTypes.add(property.getEntrySchema().getTypeDocConceptKey());
 117             }
 118         }
 119
 120         var set = ToscaUtils.getPredefinedDataTypes().stream().map(DocConceptKey::new).collect(Collectors.toSet());
 121         referencedDataTypes.removeAll(set);
 122         return referencedDataTypes;
 123     }
 124 }