annotate src/main/java/de/intevation/lada/data/Repository.java @ 86:d408eaa7c11b

Added success attribute which indicates that the operation on the repository was successfull.
author Torsten Irländer <torsten.irlaender@intevation.de>
date Fri, 07 Jun 2013 15:17:18 +0200
parents 7b932d54719c
children 36b2191c3fcb
rev   line source
43
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
1 package de.intevation.lada.data;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
2
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
3 import java.util.List;
84
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
4 import java.util.Map;
43
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
5
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
6 import javax.enterprise.context.ApplicationScoped;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
7 import javax.inject.Inject;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
8 import javax.persistence.EntityManager;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
9 import javax.persistence.criteria.CriteriaBuilder;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
10 import javax.persistence.criteria.CriteriaQuery;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
11 import javax.persistence.criteria.Root;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
12 import javax.inject.Named;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
13
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
14 /**
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
15 * This generic Container is an interface to request and select Data
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
16 * obejcts from the connected database.
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
17 *
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
18 * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
19 */
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
20 @Named
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
21 @ApplicationScoped
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
22 public class Repository
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
23 {
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
24 /**
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
25 * The entitymanager managing the data.
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
26 */
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
27 @Inject
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
28 private EntityManager em;
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
29
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
30 /**
84
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
31 * Errors/Warnings occured in repository operations.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
32 */
86
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
33 private boolean success;
84
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
34 private int generalError;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
35 private Map<String, Integer> errors;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
36 private Map<String, Integer> warnings;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
37
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
38 /**
43
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
39 * Get all objects of type <link>clazz</link>from database.
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
40 *
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
41 * @param clazz The class type.
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
42 * @return List of objects.
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
43 */
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
44 public <T> List<T> findAll(Class<T> clazz) {
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
45 CriteriaBuilder builder = em.getCriteriaBuilder();
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
46 CriteriaQuery<T> criteria = builder.createQuery(clazz);
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
47 Root<T> member = criteria.from(clazz);
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
48 criteria.select(member);
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
49 return em.createQuery(criteria).getResultList();
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
50 }
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
51
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
52 /**
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
53 * Find a single object identified by its id.
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
54 *
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
55 * @param clazz The class type.
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
56 * @param id The object id.
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
57 * @return The requested object of type clazz
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
58 */
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
59 public <T> T findById(Class<T> clazz, String id) {
85
7b932d54719c Set general error on loading items.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 84
diff changeset
60 T item = em.find(clazz, id);
7b932d54719c Set general error on loading items.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 84
diff changeset
61 if (item == null) {
7b932d54719c Set general error on loading items.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 84
diff changeset
62 this.setGeneralError(600);
7b932d54719c Set general error on loading items.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 84
diff changeset
63 }
7b932d54719c Set general error on loading items.
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 84
diff changeset
64 return item;
43
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
65 }
84
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
66
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
67 /**
86
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
68 * Getter for the success boolean which indicates whether the request
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
69 * succeeds.
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
70 *
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
71 * @return The true or false.
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
72 */
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
73 public boolean getSuccess() {
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
74 return this.success;
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
75 }
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
76
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
77 /**
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
78 * Protected setter for the success boolean which indicates whether the
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
79 * request succeeds.
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
80 *
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
81 */
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
82 public void setSuccess(boolean success) {
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
83 this.success = success;
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
84 }
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
85
d408eaa7c11b Added success attribute which indicates that the operation on the repository
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 85
diff changeset
86 /**
84
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
87 * Getter for the error code returned by the validator.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
88 *
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
89 * @return The error code returned by the validator.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
90 */
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
91 public int getGeneralError() {
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
92 return generalError;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
93 }
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
94
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
95 /**
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
96 * Protected setter for the general error code.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
97 *
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
98 * @param generalError
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
99 */
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
100 protected void setGeneralError(int generalError) {
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
101 this.generalError = generalError;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
102 }
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
103
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
104 /**
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
105 * Getter for all errors occured while validating a LProbe object.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
106 *
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
107 * @return Map of field - error code pairs.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
108 */
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
109 public Map<String, Integer> getErrors() {
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
110 return errors;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
111 }
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
112
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
113 /**
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
114 * Protected setter for validation errors.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
115 *
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
116 * @param errors
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
117 */
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
118 protected void setErrors(Map<String, Integer> errors) {
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
119 this.errors = errors;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
120 }
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
121
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
122 /**
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
123 * Getter for all warnings occured while validating a LProbe object.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
124 *
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
125 * @return Map of field - error code pairs.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
126 */
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
127 public Map<String, Integer> getWarnings() {
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
128 return warnings;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
129 }
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
130
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
131 /**
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
132 * Protected setter for validation warnings.
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
133 *
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
134 * @param warnings
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
135 */
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
136 protected void setWarnings(Map<String, Integer> warnings) {
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
137 this.warnings = warnings;
74a488e52dde Moved errors and warnings from LProbeRepository to Repository as they are
Torsten Irländer <torsten.irlaender@intevation.de>
parents: 43
diff changeset
138 }
43
13178bbe77ff New generic repository for data requests.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
139 }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)