1 // license-header java merge-point
2 //
3 // Attention: Generated code! Do not modify by hand!
4 // Generated by: SpringDao.vsl in andromda-spring-cartridge.
5 //
6 package fr.ifremer.quadrige3.core.dao.data.measurement;
7
8 /*-
9 * #%L
10 * Quadrige3 Core :: Client API
11 * %%
12 * Copyright (C) 2017 - 2024 Ifremer
13 * %%
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Affero General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU Affero General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 * #L%
27 */
28 import fr.ifremer.quadrige3.core.dao.Search;
29 import fr.ifremer.quadrige3.core.dao.referential.ObjectType;
30 import fr.ifremer.quadrige3.core.dao.referential.QualityFlag;
31 import fr.ifremer.quadrige3.core.dao.referential.pmfm.Pmfm;
32 import java.sql.Timestamp;
33 import java.util.Collection;
34 import java.util.Date;
35 import java.util.Set;
36 import org.andromda.spring.PaginationResult;
37
38 /**
39 * Résultat de mesure faisant l'objet d'une valeur unique.
40 * @see Measurement
41 */
42 public interface MeasurementDao
43 {
44 /**
45 * This constant is used as a transformation flag; entities can be converted automatically into value objects
46 * or other types, different methods in a class implementing this interface support this feature: look for
47 * an <code>int</code> parameter called <code>transform</code>.
48 * <p>
49 * This specific flag denotes no transformation will occur.
50 */
51 public static final int TRANSFORM_NONE = 0;
52
53
54 /**
55 * Transforms the given results to a collection of {@link Measurement}
56 * instances (this is useful when the returned results contains a row of data and you want just entities only).
57 *
58 * @param results the query results.
59 */
60 public void toEntities(final Collection<?> results);
61
62 /**
63 * Gets an instance of Measurement from the persistent store.
64 * @param measId
65 * @return Measurement
66 */
67 public Measurement get(Integer measId);
68
69 /**
70 * <p>
71 * Does the same thing as {@link #get(Integer)} with an
72 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
73 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
74 * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
75 * optionally transform the entity (into a value object for example). By default, transformation does
76 * not occur.
77 * </p>
78 *
79 * @param transform flag to determine transformation type.
80 * @param measId the identifier of the entity to get.
81 * @return either the entity or the object transformed from the entity.
82 */
83 public Object get(int transform, Integer measId);
84
85 /**
86 * Loads an instance of Measurement from the persistent store.
87 * @param measId
88 * @return Measurement
89 */
90 public Measurement load(Integer measId);
91
92 /**
93 * <p>
94 * Does the same thing as {@link #load(Integer)} with an
95 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
96 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
97 * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
98 * optionally transform the entity (into a value object for example). By default, transformation does
99 * not occur.
100 * </p>
101 *
102 * @param transform flag to determine transformation type.
103 * @param measId the identifier of the entity to load.
104 * @return either the entity or the object transformed from the entity.
105 */
106 public Object load(int transform, Integer measId);
107
108 /**
109 * Loads all entities of type {@link Measurement}.
110 *
111 * @return the loaded entities.
112 */
113 public Collection<Measurement> loadAll();
114
115 /**
116 * <p>
117 * Does the same thing as {@link #loadAll()} with an
118 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
119 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
120 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
121 * transform the entity (into a value object for example). By default, transformation does
122 * not occur.
123 * </p>
124 *
125 * @param transform the flag indicating what transformation to use.
126 * @return the loaded entities.
127 */
128 public Collection<?> loadAll(final int transform);
129
130 /**
131 * <p>
132 * Does the same thing as {@link #loadAll()} with an
133 * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
134 * argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the
135 * page retrieved.
136 * </p>
137 *
138 * @param pageNumber the page number to retrieve when paging results.
139 * @param pageSize the size of the page to retrieve when paging results.
140 * @return the loaded entities.
141 */
142 public Collection<?> loadAll(final int pageNumber, final int pageSize);
143
144 /**
145 * <p>
146 * Does the same thing as {@link #loadAll(int)} with an
147 * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
148 * argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the
149 * page retrieved.
150 * </p>
151 *
152 * @param transform the flag indicating what transformation to use.
153 * @param pageNumber the page number to retrieve when paging results.
154 * @param pageSize the size of the page to retrieve when paging results.
155 * @return the loaded entities.
156 */
157 public Collection<?> loadAll(final int transform, final int pageNumber, final int pageSize);
158
159 /**
160 * Creates an instance of Measurement and adds it to the persistent store.
161 * @param measurement
162 * @return Measurement
163 */
164 public Measurement create(Measurement measurement);
165
166 /**
167 * <p>
168 * Does the same thing as {@link #create(Measurement)} with an
169 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
170 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
171 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
172 * transform the entity (into a value object for example). By default, transformation does
173 * not occur.
174 * </p>
175 * @param transform
176 * @param measurement
177 * @return Object
178 */
179 public Object create(int transform, Measurement measurement);
180
181 /**
182 * Creates a new instance of Measurement and adds
183 * from the passed in <code>entities</code> collection
184 *
185 * @param entities the collection of Measurement
186 * instances to create.
187 *
188 * @return the created instances.
189 */
190 public Collection<Measurement> create(Collection<Measurement> entities);
191
192 /**
193 * <p>
194 * Does the same thing as {@link #create(Measurement)} with an
195 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
196 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
197 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
198 * transform the entities (into value objects for example). By default, transformation does
199 * not occur.
200 * </p>
201 * @param transform
202 * @param entities
203 * @return Collection
204 */
205 public Collection<?> create(int transform, Collection<Measurement> entities);
206
207 /**
208 * <p>
209 * Creates a new <code>Measurement</code>
210 * instance from <strong>all</strong> attributes and adds it to
211 * the persistent store.
212 * </p>
213 * @param objectId Identifiant interne de donnnée in situ de référence (passage, prélèvement, prélèvement)
214 * @param measIndivId Le numéro de l'individu mesuré pour les résultats ayant plusieurs individus
215 * @param measNumerValue La valeur du résultat si elle n'est pas qualitative
216 * @param measPrecisionValue La valeur de l'incertitude. Ex : 2 (%) ou 0,01 (dégrés)
217 * @param measDigitNumber Nombre de chiffre après la virgule du résulat. Ex : si on saisit 10.00, il faut conserver 2 comme
218 information
219 * @param measControlDt Date de contrôle
220 * @param measValidDt Date de validation
221 * @param measQualifDt Date de la qualification du résultat
222 * @param measQualifCm Commentaire sur la qualification du résultat
223 Un commentaire de qualification est obligatoire si la mesure est douteuse ou mauvaise.
224 * @param measCm Commentaire sur le résultat de mesure
225 * @param updateDt Date de modification de l'objet, mise à jour par le système
226 * @param remoteId
227 * @return Measurement
228 */
229 public Measurement create(
230 Integer objectId,
231 Integer measIndivId,
232 Float measNumerValue,
233 Float measPrecisionValue,
234 Integer measDigitNumber,
235 Date measControlDt,
236 Date measValidDt,
237 Date measQualifDt,
238 String measQualifCm,
239 String measCm,
240 Timestamp updateDt,
241 Integer remoteId);
242
243 /**
244 * <p>
245 * Does the same thing as {@link #create(Integer, Integer, Float, Float, Integer, Date, Date, Date, String, String, Timestamp, Integer)} with an
246 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
247 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
248 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
249 * transform the entity (into a value object for example). By default, transformation does
250 * not occur.
251 * </p>
252 * @param transform
253 * @param objectId Identifiant interne de donnnée in situ de référence (passage, prélèvement, prélèvement)
254 * @param measIndivId Le numéro de l'individu mesuré pour les résultats ayant plusieurs individus
255 * @param measNumerValue La valeur du résultat si elle n'est pas qualitative
256 * @param measPrecisionValue La valeur de l'incertitude. Ex : 2 (%) ou 0,01 (dégrés)
257 * @param measDigitNumber Nombre de chiffre après la virgule du résulat. Ex : si on saisit 10.00, il faut conserver 2 comme
258 information
259 * @param measControlDt Date de contrôle
260 * @param measValidDt Date de validation
261 * @param measQualifDt Date de la qualification du résultat
262 * @param measQualifCm Commentaire sur la qualification du résultat
263 Un commentaire de qualification est obligatoire si la mesure est douteuse ou mauvaise.
264 * @param measCm Commentaire sur le résultat de mesure
265 * @param updateDt Date de modification de l'objet, mise à jour par le système
266 * @param remoteId
267 * @return Measurement
268 */
269 public Object create(
270 int transform,
271 Integer objectId,
272 Integer measIndivId,
273 Float measNumerValue,
274 Float measPrecisionValue,
275 Integer measDigitNumber,
276 Date measControlDt,
277 Date measValidDt,
278 Date measQualifDt,
279 String measQualifCm,
280 String measCm,
281 Timestamp updateDt,
282 Integer remoteId);
283
284 /**
285 * <p>
286 * Creates a new <code>Measurement</code>
287 * instance from only <strong>required</strong> properties (attributes
288 * and association ends) and adds it to the persistent store.
289 * </p>
290 * @param objectId
291 * @param objectType
292 * @param pmfm
293 * @param qualityFlag
294 * @return Measurement
295 */
296 public Measurement create(
297 Integer objectId,
298 ObjectType objectType,
299 Pmfm pmfm,
300 QualityFlag qualityFlag);
301
302 /**
303 * <p>
304 * Does the same thing as {@link #create(Integer)} with an
305 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
306 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
307 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
308 * transform the entity (into a value object for example). By default, transformation does
309 * not occur.
310 * </p>
311 * @param transform flag to determine transformation type.
312 * @param objectId
313 * @param objectType
314 * @param pmfm
315 * @param qualityFlag
316 * @return Object
317 */
318 public Object create(
319 int transform,
320 Integer objectId,
321 ObjectType objectType,
322 Pmfm pmfm,
323 QualityFlag qualityFlag);
324
325 /**
326 * Updates the <code>measurement</code> instance in the persistent store.
327 * @param measurement
328 */
329 public void update(Measurement measurement);
330
331 /**
332 * Updates all instances in the <code>entities</code> collection in the persistent store.
333 * @param entities
334 */
335 public void update(Collection<Measurement> entities);
336
337 /**
338 * Removes the instance of Measurement from the persistent store.
339 * @param measurement
340 */
341 public void remove(Measurement measurement);
342
343 /**
344 * Removes the instance of Measurement having the given
345 * <code>identifier</code> from the persistent store.
346 * @param measId
347 */
348 public void remove(Integer measId);
349
350 /**
351 * Removes all entities in the given <code>entities</code> collection.
352 * @param entities
353 */
354 public void remove(Collection<Measurement> entities);
355
356
357 /**
358 * Does the same thing as {@link #search(int, Search)} but with an
359 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
360 * limit your data to a specified page number and size.
361 *
362 * @param transform the transformation flag.
363 * @param pageNumber the page number in the data to retrieve
364 * @param pageSize the size of the page to retrieve.
365 * @param search the search object which provides the search parameters and pagination specification.
366 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
367 */
368 public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
369
370 /**
371 * Does the same thing as {@link #search(Search)} but with an
372 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
373 * limit your data to a specified page number and size.
374 *
375 * @param pageNumber the page number in the data to retrieve
376 * @param pageSize the size of the page to retrieve.
377 * @param search the search object which provides the search parameters and pagination specification.
378 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
379 */
380 public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
381
382 /**
383 * Does the same thing as {@link #search(Search)} but with an
384 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
385 * finder results will <strong>NOT</strong> be transformed during retrieval.
386 * If this flag is any of the other constants defined here
387 * then results <strong>WILL BE</strong> passed through an operation which can optionally
388 * transform the entities (into value objects for example). By default, transformation does
389 * not occur.
390 *
391 * @param transform the transformation flag.
392 * @param search the search object which provides the search parameters and pagination specification.
393 * @return any found results from the search.
394 */
395 public Set<?> search(final int transform, final Search search);
396
397 /**
398 * Performs a search using the parameters specified in the given <code>search</code> object.
399 *
400 * @param search the search object which provides the search parameters and pagination specification.
401 * @return any found results from the search.
402 */
403 public Set<Measurement> search(final Search search);
404
405 /**
406 * Allows transformation of entities into value objects
407 * (or something else for that matter), when the <code>transform</code>
408 * flag is set to one of the constants defined in <code>fr.ifremer.quadrige3.core.dao.data.measurement.MeasurementDao</code>, please note
409 * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
410 * will be returned.
411 *
412 * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
413 *
414 * @param transform one of the constants declared in {@link fr.ifremer.quadrige3.core.dao.data.measurement.MeasurementDao}
415 * @param entity an entity that was found
416 * @return the transformed entity (i.e. new value object, etc)
417 * @see #transformEntities(int,Collection)
418 */
419 public Object transformEntity(final int transform, final Measurement entity);
420
421 /**
422 * Transforms a collection of entities using the
423 * {@link #transformEntity(int,Measurement)}
424 * method. This method does not instantiate a new collection.
425 * <p>
426 * This method is to be used internally only.
427 *
428 * @param transform one of the constants declared in <code>fr.ifremer.quadrige3.core.dao.data.measurement.MeasurementDao</code>
429 * @param entities the collection of entities to transform
430 * @see #transformEntity(int,Measurement)
431 */
432 public void transformEntities(final int transform, final Collection<?> entities);
433
434 // spring-dao merge-point
435 }