-
Notifications
You must be signed in to change notification settings - Fork 14
/
TypedQuery.java
152 lines (139 loc) · 5.86 KB
/
TypedQuery.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
/**
* 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.query;
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.exceptions.TransactionRequiredException;
import cz.cvut.kbss.jopa.model.descriptors.Descriptor;
import java.util.List;
/**
* Interface used to control the execution of typed queries.
*
* @param <X> Query result type
*/
public interface TypedQuery<X> extends Query {
/**
* Execute a SELECT query and return the query results as a typed List.
*
* @return a list of the results
* @throws IllegalStateException if called for a Java Persistence query language UPDATE or DELETE statement
* @throws TransactionRequiredException if a lock mode has been set and there is no transaction
* @throws OWLPersistenceException if the query execution exceeds the query timeout value set and the
* transaction is rolled back
*/
@Override
List<X> getResultList();
/**
* Execute a SELECT query that returns a single result.
*
* @return Query result
* @throws NoResultException There is no result
* @throws NoUniqueResultException There are more than one results
*/
@Override
X getSingleResult();
/**
* Set the maximum number of results to retrieve.
*
* @param maxResult maximum number of results
* @return the same query instance
* @throws IllegalArgumentException if the argument is negative
*/
@Override
TypedQuery<X> setMaxResults(int maxResult);
/**
* Binds an argument value to a positional parameter.
*
* @param position position
* @param value parameter value
* @return this query instance
* @throws IllegalArgumentException If position does not correspond to a positional parameter of the query or if the
* argument is of incorrect type
*/
@Override
TypedQuery<X> setParameter(int position, Object value);
/**
* Binds a String argument value to a positional parameter.
*
* @param position position
* @param value parameter value
* @param language language tag for the parameter value
* @return this query instance
* @throws IllegalArgumentException If position does not correspond to a positional parameter of the query or if the
* argument is of incorrect type
*/
@Override
TypedQuery<X> setParameter(int position, String value, String language);
/**
* Binds an argument value to a named parameter.
*
* @param name parameter name
* @param value parameter value
* @return this query instance
* @throws IllegalArgumentException If the parameter name does not correspond to a parameter of the query or if the
* argument is of incorrect type
*/
@Override
TypedQuery<X> setParameter(String name, Object value);
/**
* Binds a String argument value to a named parameter.
*
* @param name parameter name
* @param value parameter value
* @param language language tag for the parameter value
* @return this query instance
* @throws IllegalArgumentException If the parameter name does not correspond to a parameter of the query or if the
* argument is of incorrect type
*/
@Override
TypedQuery<X> setParameter(String name, String value, String language);
/**
* Binds the value of a Parameter object.
*
* @param parameter parameter object
* @param value parameter value
* @return this query instance
* @throws IllegalArgumentException If the parameter does not correspond to a parameter of the query
*/
@Override
<T> TypedQuery<X> setParameter(Parameter<T> parameter, T value);
/**
* Binds the value of a String Parameter.
*
* @param parameter parameter object
* @param value parameter value
* @param language language tag for the parameter value
* @return this query instance
* @throws IllegalArgumentException If the parameter does not correspond to a parameter of the query
*/
@Override
TypedQuery<X> setParameter(Parameter<String> parameter, String value, String language);
/**
* Sets descriptor to use with this query.
* <p>
* The descriptor may specify contexts and languages for the retrieved query results. Note that the descriptor
* applies only to results of managed types, i.e. when the result type of the query is a managed type. Otherwise,
* the descriptor is ignored.
* <p>
* Use of descriptor may lead to additional result filtering, e.g. when the individual, which is a result of the
* query, does not match criteria in the descriptor (it is in a different context, for instance), it is not returned
* by {@link #getResultList()} and {@link #getSingleResult()}.
*
* @param descriptor The descriptor to use
* @return This query instance
*/
TypedQuery<X> setDescriptor(Descriptor descriptor);
}