-
Notifications
You must be signed in to change notification settings - Fork 14
/
AbstractQuery.java
221 lines (191 loc) · 7.6 KB
/
AbstractQuery.java
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
220
221
/**
* Copyright (C) 2016 Czech Technical University in Prague
* <p>
* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
* version.
* <p>
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details. You should have received a copy of the GNU General Public License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
*/
package cz.cvut.kbss.jopa.model;
import cz.cvut.kbss.jopa.exceptions.NoResultException;
import cz.cvut.kbss.jopa.exceptions.NoUniqueResultException;
import cz.cvut.kbss.jopa.exceptions.OWLPersistenceException;
import cz.cvut.kbss.jopa.model.query.Parameter;
import cz.cvut.kbss.jopa.model.query.Query;
import cz.cvut.kbss.jopa.query.QueryHolder;
import cz.cvut.kbss.jopa.sessions.ConnectionWrapper;
import cz.cvut.kbss.jopa.utils.ErrorUtils;
import cz.cvut.kbss.jopa.utils.Procedure;
import cz.cvut.kbss.jopa.utils.ThrowingConsumer;
import cz.cvut.kbss.ontodriver.ResultSet;
import cz.cvut.kbss.ontodriver.Statement;
import cz.cvut.kbss.ontodriver.exception.OntoDriverException;
import cz.cvut.kbss.ontodriver.iteration.ResultRow;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Objects;
import java.util.Set;
/**
* Common state and behavior of both {@link cz.cvut.kbss.jopa.model.query.Query} and {@link
* cz.cvut.kbss.jopa.model.query.TypedQuery} implementations.
*/
abstract class AbstractQuery implements Query {
private static final Logger LOG = LoggerFactory.getLogger(AbstractQuery.class);
final QueryHolder query;
private final ConnectionWrapper connection;
private boolean useBackupOntology = false;
private Procedure rollbackOnlyMarker;
private Procedure ensureOpenProcedure;
AbstractQuery(QueryHolder query, ConnectionWrapper connection) {
this.query = Objects.requireNonNull(query, ErrorUtils.getNPXMessageSupplier("query"));
this.connection = Objects.requireNonNull(connection, ErrorUtils.getNPXMessageSupplier("connection"));
}
/**
* Sets ontology used for processing of this query.
*
* @param useBackupOntology If true, the backup (central) ontology is used, otherwise the transactional ontology is
* used (default)
*/
public void useBackupOntology(boolean useBackupOntology) {
this.useBackupOntology = useBackupOntology;
}
private void logQuery() {
if (LOG.isTraceEnabled()) {
LOG.trace("Executing query: {}", query.assembleQuery());
}
}
private void setTargetOntology(Statement stmt) {
if (useBackupOntology) {
stmt.useOntology(Statement.StatementOntology.CENTRAL);
} else {
stmt.useOntology(Statement.StatementOntology.TRANSACTIONAL);
}
}
OWLPersistenceException queryEvaluationException(OntoDriverException e) {
final String executedQuery = query.assembleQuery();
return new OWLPersistenceException("Exception caught when evaluating query " + executedQuery, e);
}
void markTransactionForRollback() {
if (rollbackOnlyMarker != null) {
rollbackOnlyMarker.execute();
}
}
void ensureOpen() {
assert ensureOpenProcedure != null;
ensureOpenProcedure.execute();
}
/**
* Registers reference to a method which marks current transaction (if active) for rollback on exceptions.
*
* @param rollbackOnlyMarker The marker to invoke on exceptions
*/
void setRollbackOnlyMarker(Procedure rollbackOnlyMarker) {
this.rollbackOnlyMarker = rollbackOnlyMarker;
}
/**
* Registers a reference to a method which ensures that the query is called on an open persistence context.
* <p>
* This method is likely to come from an {@link EntityManager} instance which was used to create this query.
*
* @param ensureOpenProcedure The procedure to call when ensuring that persistence context is open
*/
void setEnsureOpenProcedure(Procedure ensureOpenProcedure) {
this.ensureOpenProcedure = ensureOpenProcedure;
}
private static IllegalStateException unboundParam(Object param) {
return new IllegalStateException("Parameter " + param + " is not bound.");
}
@Override
public void executeUpdate() {
ensureOpen();
final Statement stmt = connection.createStatement();
try {
setTargetOntology(stmt);
logQuery();
stmt.executeUpdate(query.assembleQuery());
} catch (OntoDriverException e) {
markTransactionForRollback();
throw queryEvaluationException(e);
} catch (RuntimeException e) {
markTransactionForRollback();
throw e;
} finally {
try {
stmt.close();
} catch (Exception e) {
LOG.error("Unable to close statement after update execution.", e);
}
}
}
@Override
public Parameter<?> getParameter(int position) {
return query.getParameter(position);
}
@Override
public Parameter<?> getParameter(String name) {
return query.getParameter(name);
}
@Override
public Set<Parameter<?>> getParameters() {
return query.getParameters();
}
@Override
public boolean isBound(Parameter<?> parameter) {
return query.getParameterValue(parameter) != null;
}
@Override
public Object getParameterValue(String name) {
final Parameter<?> param = query.getParameter(name);
return getParameterValue(param);
}
@Override
public Object getParameterValue(int position) {
final Parameter<?> param = query.getParameter(position);
return getParameterValue(param);
}
@Override
public <T> T getParameterValue(Parameter<T> parameter) {
if (!isBound(parameter)) {
throw unboundParam(parameter);
}
return (T) query.getParameterValue(parameter);
}
@Override
public int getMaxResults() {
return query.getMaxResults();
}
@Override
public int getFirstResult() {
return query.getFirstResult();
}
void checkNumericParameter(int param, String name) {
if (param < 0) {
markTransactionForRollback();
throw new IllegalArgumentException("Cannot set " + name + " to less than 0.");
}
}
/**
* Executes the query and lets the specified consumer deal with each row in the result set.
*
* @param consumer Called for every row in the result set
* @throws OntoDriverException When something goes wrong during query evaluation or result set processing
*/
void executeQuery(ThrowingConsumer<ResultRow, OntoDriverException> consumer) throws OntoDriverException {
try (final Statement stmt = connection.createStatement()) {
setTargetOntology(stmt);
logQuery();
final ResultSet rs = stmt.executeQuery(query.assembleQuery());
// TODO register this as observer on the result set so that additional results can be loaded asynchronously
for (ResultRow row : rs) {
consumer.accept(row);
}
}
}
protected boolean exceptionCausesRollback(RuntimeException e) {
return !(e instanceof NoUniqueResultException) && !(e instanceof NoResultException);
}
}