eed351df573a79e3cf34d80cab5ee27eb1e0303b
[policy/models.git] / models-tosca / src / main / java / org / onap / policy / models / tosca / simple / concepts / JpaToscaRelationshipTypes.java
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2020 Nordix Foundation.
4  *  Modifications Copyright (C) 2020 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.List;
25 import java.util.Map;
26 import java.util.TreeMap;
27 import javax.persistence.Entity;
28 import javax.persistence.Inheritance;
29 import javax.persistence.InheritanceType;
30 import javax.persistence.Table;
31 import lombok.Data;
32 import lombok.EqualsAndHashCode;
33 import lombok.ToString;
34 import org.onap.policy.common.parameters.BeanValidationResult;
35 import org.onap.policy.models.base.PfConceptContainer;
36 import org.onap.policy.models.base.PfConceptKey;
37 import org.onap.policy.models.tosca.authorative.concepts.ToscaRelationshipType;
38 import org.onap.policy.models.tosca.utils.ToscaUtils;
39
40 /**
41  * This class is a container for TOSCA relationship types.
42  */
43 @Entity
44 @Table(name = "ToscaRelationshipTypes")
45 @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
46 @Data
47 @ToString(callSuper = true)
48 @EqualsAndHashCode(callSuper = true)
49 public class JpaToscaRelationshipTypes extends PfConceptContainer<JpaToscaRelationshipType, ToscaRelationshipType> {
50     public static final String DEFAULT_NAME = "ToscaRelationshipTypesSimple";
51     public static final String DEFAULT_VERSION = "1.0.0";
52     private static final long serialVersionUID = -4157979965271220098L;
53
54     /**
55      * The Default Constructor creates a {@link JpaToscaRelationshipTypes} object with a null artifact key and creates
56      * an empty concept map.
57      */
58     public JpaToscaRelationshipTypes() {
59         super(new PfConceptKey(DEFAULT_NAME, DEFAULT_VERSION));
60     }
61
62     /**
63      * The Key Constructor creates a {@link JpaToscaRelationshipTypes} object with the given artifact key and creates an
64      * empty concept map.
65      *
66      * @param key the concept key
67      */
68     public JpaToscaRelationshipTypes(final PfConceptKey key) {
69         super(key, new TreeMap<>());
70     }
71
72     /**
73      * This Constructor creates an concept container with all of its fields defined.
74      *
75      * @param key        the concept container key
76      * @param conceptMap the concepts to be stored in the concept container
77      */
78     public JpaToscaRelationshipTypes(final PfConceptKey key,
79                                      final Map<PfConceptKey, JpaToscaRelationshipType> conceptMap) {
80         super(key, conceptMap);
81     }
82
83     /**
84      * Copy constructor.
85      *
86      * @param copyConcept the concept to copy from
87      */
88     public JpaToscaRelationshipTypes(final JpaToscaRelationshipTypes copyConcept) {
89         super(copyConcept);
90     }
91
92     /**
93      * Authorative constructor.
94      *
95      * @param authorativeConceptMapList the authorative concept to copy from
96      */
97     public JpaToscaRelationshipTypes(final List<Map<String, ToscaRelationshipType>> authorativeConceptMapList) {
98         super(new PfConceptKey(DEFAULT_NAME, DEFAULT_VERSION));
99         this.fromAuthorative(authorativeConceptMapList);
100     }
101
102     @Override
103     public BeanValidationResult validate(String fieldName) {
104         BeanValidationResult result = super.validate(fieldName);
105
106         // Check that all ancestors of this policy type exist
107         for (JpaToscaRelationshipType relationshipType : this.getConceptMap().values()) {
108             ToscaUtils.getEntityTypeAncestors(this, relationshipType, result);
109         }
110
111         return result;
112     }
113 }