aboutsummaryrefslogtreecommitdiffstats
path: root/models-tosca/src/main/java/org/onap/policy/models/tosca/simple/concepts/JpaToscaModel.java
blob: 5f72e2ba85fea94d0de65b4e35261e02806c6cf3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019-2020,2023 Nordix Foundation.
 *  Modifications Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
 *  Modifications Copyright (C) 2022 Bell Canada. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.models.tosca.simple.concepts;

import java.util.List;
import javax.persistence.CascadeType;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.Inheritance;
import javax.persistence.InheritanceType;
import javax.persistence.JoinColumn;
import javax.persistence.JoinColumns;
import javax.persistence.OneToOne;
import javax.persistence.Table;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NonNull;
import org.onap.policy.common.parameters.annotations.Valid;
import org.onap.policy.models.base.PfConcept;
import org.onap.policy.models.base.PfConceptKey;
import org.onap.policy.models.base.PfKey;
import org.onap.policy.models.base.PfModel;
import org.onap.policy.models.base.PfModelService;

/**
 * A container class for a TOSCA model with multiple service templates. This class is a container class that allows a
 * model with many service templates to be constructed that contains a well formed overall TOSCA model.
 *
 * <p>Validation runs {@link JpaToscaModel} validation on the model and all its sub concepts.
 */

@Entity
@Table(name = "ToscaModel")
@Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
@Data
@EqualsAndHashCode(callSuper = true)
public class JpaToscaModel extends PfModel {
    private static final long serialVersionUID = 8800599637708309945L;

    @OneToOne(fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval = true)
    @JoinColumns({
        @JoinColumn(name = "serviceTemplatesName", referencedColumnName = "name"),
        @JoinColumn(name = "serviceTemplatesVersion", referencedColumnName = "version")
    })
    @Valid
    private JpaToscaServiceTemplates serviceTemplates;

    /**
     * The Default Constructor creates a {@link JpaToscaModel} object with a null concept key and creates an empty TOSCA
     * model.
     */
    public JpaToscaModel() {
        this(new PfConceptKey());
    }

    /**
     * The Key Constructor creates a {@link JpaToscaModel} object with the given concept key and creates an empty TOSCA
     * model.
     *
     * @param key the TOSCA model key
     */
    public JpaToscaModel(final PfConceptKey key) {
        this(key, new JpaToscaServiceTemplates(new PfConceptKey()));
    }

    /**
     * Constructor that initiates a {@link JpaToscaModel} with all its fields.
     *
     * @param key the TOSCA model key
     * @param serviceTemplates the service templates in the event model
     */
    public JpaToscaModel(@NonNull final PfConceptKey key, @NonNull final JpaToscaServiceTemplates serviceTemplates) {
        super(key);
        this.serviceTemplates = serviceTemplates;
    }

    /**
     * Copy constructor.
     *
     * @param copyConcept the concept to copy from
     */
    public JpaToscaModel(@NonNull final JpaToscaModel copyConcept) {
        super(copyConcept);
        this.serviceTemplates = new JpaToscaServiceTemplates(copyConcept.serviceTemplates);
    }

    @Override
    public void register() {
        PfModelService.registerModel(serviceTemplates.getId(), getServiceTemplates());
    }

    @Override
    public List<PfKey> getKeys() {
        final List<PfKey> keyList = super.getKeys();

        keyList.addAll(serviceTemplates.getKeys());

        return keyList;
    }

    @Override
    public void clean() {
        super.clean();
        serviceTemplates.clean();
    }

    @Override
    public int compareTo(final PfConcept otherConcept) {
        if (otherConcept == null) {
            return -1;
        }

        if (this == otherConcept) {
            return 0;
        }

        if (getClass() != otherConcept.getClass()) {
            return getClass().getName().compareTo(otherConcept.getClass().getName());
        }

        final JpaToscaModel other = (JpaToscaModel) otherConcept;
        int result = super.compareTo(other);
        if (result != 0) {
            return result;
        }

        return serviceTemplates.compareTo(other.serviceTemplates);
    }
}