aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/policy/clamp/tosca/Dictionary.java
blob: 4b01d69020565a3926d67532f1203a2d48205321 (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*-
 * ============LICENSE_START=======================================================
 * ONAP CLAMP
 * ================================================================================
 * Copyright (C) 2020 AT&T Intellectual Property. 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.
 * ============LICENSE_END============================================
 * ===================================================================
 *
 */

package org.onap.policy.clamp.tosca;

import com.google.gson.annotations.Expose;
import java.io.Serializable;
import java.util.HashSet;
import java.util.Set;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.Table;
import org.onap.policy.clamp.loop.common.AuditEntity;

/**
 * Represents Dictionary.
 */

@Entity
@Table(name = "dictionary")
public class Dictionary extends AuditEntity implements Serializable {

    /**
     * The serial version id.
     */
    private static final long serialVersionUID = -286522707701388645L;

    @Id
    @Expose
    @Column(nullable = false, name = "name", unique = true)
    private String name;

    @Expose
    @Column(name = "dictionary_second_level")
    private int secondLevelDictionary = 0;

    @Expose
    @Column(name = "dictionary_type")
    private String subDictionaryType;

    @Expose
    @ManyToMany(fetch = FetchType.EAGER, cascade = {CascadeType.ALL})
    @JoinTable(
        name = "dictionary_to_dictionaryelements",
        joinColumns = @JoinColumn(name = "dictionary_name", referencedColumnName = "name"),
        inverseJoinColumns = {@JoinColumn(
            name = "dictionary_element_short_name",
            referencedColumnName = "short_name")})
    private Set<DictionaryElement> dictionaryElements = new HashSet<>();

    /**
     * name getter.
     *
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * name setter.
     *
     * @param name the name to set
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * secondLevelDictionary getter.
     *
     * @return the secondLevelDictionary
     */
    public int getSecondLevelDictionary() {
        return secondLevelDictionary;
    }

    /**
     * secondLevelDictionary setter.
     *
     * @param secondLevelDictionary the secondLevelDictionary to set
     */
    public void setSecondLevelDictionary(int secondLevelDictionary) {
        this.secondLevelDictionary = secondLevelDictionary;
    }

    /**
     * subDictionaryType getter.
     *
     * @return the subDictionaryType
     */
    public String getSubDictionaryType() {
        return subDictionaryType;
    }

    /**
     * subDictionaryType setter.
     *
     * @param subDictionaryType the subDictionaryType to set
     */
    public void setSubDictionaryType(String subDictionaryType) {
        this.subDictionaryType = subDictionaryType;
    }

    /**
     * dictionaryElements getter.
     *
     * @return the dictionaryElements List of dictionary element
     */
    public Set<DictionaryElement> getDictionaryElements() {
        return dictionaryElements;
    }

    /**
     * Method to add a new dictionaryElement to the list.
     *
     * @param dictionaryElement The dictionary element
     */
    public void addDictionaryElements(DictionaryElement dictionaryElement) {
        dictionaryElements.add(dictionaryElement);
        dictionaryElement.getUsedByDictionaries().add(this);
    }

    /**
     * Method to set dictionaryElements.
     *
     * @param dictionaryElements The dictionary elements set
     */
    public void setDictionaryElements(Set<DictionaryElement> dictionaryElements) {
        this.dictionaryElements = dictionaryElements;
    }

    /**
     * Method to delete a dictionaryElement from the list.
     *
     * @param dictionaryElement The dictionary element
     */
    public void removeDictionaryElement(DictionaryElement dictionaryElement) {
        dictionaryElements.remove(dictionaryElement);
        dictionaryElement.getUsedByDictionaries().remove(this);
    }

    /**
     * Default Constructor.
     */
    public Dictionary() {

    }

    /**
     * Constructor.
     *
     * @param name The Dictionary name
     * @param secondLevelDictionary defines if dictionary is a secondary level
     * @param subDictionaryType defines the type of secondary level dictionary
     */
    public Dictionary(String name, int secondLevelDictionary, String subDictionaryType) {
        this.name = name;
        this.secondLevelDictionary = secondLevelDictionary;
        this.subDictionaryType = subDictionaryType;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((name == null) ? 0 : name.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        Dictionary other = (Dictionary) obj;
        if (name == null) {
            if (other.name != null) {
                return false;
            }
        } else if (!name.equals(other.name)) {
            return false;
        }
        return true;
    }

}