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
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2016-2018 Ericsson. 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.apex.model.basicmodel.dao;
import java.util.Collection;
import java.util.List;
import org.onap.apex.model.basicmodel.concepts.ApexException;
import org.onap.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.apex.model.basicmodel.concepts.AxConcept;
import org.onap.apex.model.basicmodel.concepts.AxReferenceKey;
/**
* The Interface ApexDao describes the DAO interface for reading and writing Apex {@link AxConcept} concepts to and from databases using
* JDBC.
*
* @author Sergey Sachkov
* @author liam.fallon@ericsson.com
*/
public interface ApexDao {
/**
* Initialize the Apex DAO with the given parameters.
*
* @param daoParameters parameters to use to access the database
* @throws ApexException on initialization errors
*/
void init(DAOParameters daoParameters) throws ApexException;
/**
* Close the Apex DAO.
*/
void close();
/**
* Creates an Apex concept on the database.
*
* @param <T> the type of the object to create, a subclass of {@link AxConcept}
* @param obj the object to create
*/
<T extends AxConcept> void create(T obj);
/**
* Delete an Apex concept on the database.
*
* @param <T> the type of the object to delete, a subclass of {@link AxConcept}
* @param obj the object to delete
*/
<T extends AxConcept> void delete(T obj);
/**
* Delete an Apex concept on the database.
*
* @param <T> the type of the object to delete, a subclass of {@link AxConcept}
* @param aClass the class of the object to delete, a subclass of {@link AxConcept}
* @param key the key of the object to delete
*/
<T extends AxConcept> void delete(Class<T> aClass, AxArtifactKey key);
/**
* Delete an Apex concept on the database.
*
* @param <T> the type of the object to delete, a subclass of {@link AxConcept}
* @param aClass the class of the object to delete, a subclass of {@link AxConcept}
* @param key the key of the object to delete
*/
<T extends AxConcept> void delete(Class<T> aClass, AxReferenceKey key);
/**
* Create a collection of objects in the database.
*
* @param <T> the type of the object to create, a subclass of {@link AxConcept}
* @param objs the objects to create
*/
<T extends AxConcept> void create(Collection<T> objs);
/**
* Delete a collection of objects in the database.
*
* @param <T> the type of the objects to delete, a subclass of {@link AxConcept}
* @param objs the objects to delete
*/
<T extends AxConcept> void delete(Collection<T> objs);
/**
* Delete a collection of objects in the database referred to by artifact key.
*
* @param <T> the type of the objects to delete, a subclass of {@link AxConcept}
* @param aClass the class of the objects to delete, a subclass of {@link AxConcept}
* @param keys the keys of the objects to delete
* @return the number of objects deleted
*/
<T extends AxConcept> int deleteByArtifactKey(Class<T> aClass, Collection<AxArtifactKey> keys);
/**
* Delete a collection of objects in the database referred to by reference key.
*
* @param <T> the type of the objects to delete, a subclass of {@link AxConcept}
* @param aClass the class of the objects to delete, a subclass of {@link AxConcept}
* @param keys the keys of the objects to delete
* @return the number of objects deleted
*/
<T extends AxConcept> int deleteByReferenceKey(Class<T> aClass, Collection<AxReferenceKey> keys);
/**
* Delete all objects of a given class in the database.
*
* @param <T> the type of the objects to delete, a subclass of {@link AxConcept}
* @param aClass the class of the objects to delete, a subclass of {@link AxConcept}
*/
<T extends AxConcept> void deleteAll(Class<T> aClass);
/**
* Get an object from the database, referred to by artifact key.
*
* @param <T> the type of the object to get, a subclass of {@link AxConcept}
* @param aClass the class of the object to get, a subclass of {@link AxConcept}
* @param key the key of the object to get
* @return the object that was retrieved from the database
*/
<T extends AxConcept> T get(Class<T> aClass, AxArtifactKey key);
/**
* Get an object from the database, referred to by reference key.
*
* @param <T> the type of the object to get, a subclass of {@link AxConcept}
* @param aClass the class of the object to get, a subclass of {@link AxConcept}
* @param key the key of the object to get
* @return the object that was retrieved from the database or null if the object was not retrieved
*/
<T extends AxConcept> T get(Class<T> aClass, AxReferenceKey key);
/**
* Get all the objects in the database of a given type.
*
* @param <T> the type of the objects to get, a subclass of {@link AxConcept}
* @param aClass the class of the objects to get, a subclass of {@link AxConcept}
* @return the objects or null if no objects were retrieved
*/
<T extends AxConcept> List<T> getAll(Class<T> aClass);
/**
* Get all the objects in the database of the given type with the given parent artifact key.
*
* @param <T> the type of the objects to get, a subclass of {@link AxConcept}
* @param aClass the class of the objects to get, a subclass of {@link AxConcept}
* @param parentKey the parent key of the concepts to get
* @return the all
*/
<T extends AxConcept> List<T> getAll(Class<T> aClass, AxArtifactKey parentKey);
/**
* Get a concept from the database with the given artifact key.
*
* @param <T> the type of the object to get, a subclass of {@link AxConcept}
* @param aClass the class of the object to get, a subclass of {@link AxConcept}
* @param artifactID the artifact key of the concept to get
* @return the concept that matches the key or null if the concept is not retrieved
*/
<T extends AxConcept> T getArtifact(Class<T> aClass, AxArtifactKey artifactID);
/**
* Get a concept from the database with the given reference key.
*
* @param <T> the type of the object to get, a subclass of {@link AxConcept}
* @param aClass the class of the object to get, a subclass of {@link AxConcept}
* @param artifactID the artifact key of the concept to get
* @return the concept that matches the key or null if the concept is not retrieved
*/
<T extends AxConcept> T getArtifact(Class<T> aClass, AxReferenceKey artifactID);
/**
* Get the number of instances of a concept that exist in the database.
*
* @param <T> the type of the object to get, a subclass of {@link AxConcept}
* @param aClass the class of the object to get, a subclass of {@link AxConcept}
* @return the number of instances of the concept in the database
*/
<T extends AxConcept> long size(Class<T> aClass);
/**
* Update a concept in the database.
*
* @param <T> the type of the object to get, a subclass of {@link AxConcept}
* @param obj the object to update
* @return the updated object
*/
<T extends AxConcept> T update(T obj);
}
|
