-
Notifications
You must be signed in to change notification settings - Fork 14
/
VariableResult.java
68 lines (64 loc) · 2.48 KB
/
VariableResult.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
/**
* Copyright (C) 2016 Czech Technical University in Prague
*
* 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.
*
* 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.annotations;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Used in conjunction with the {@link SparqlResultSetMapping} annotation or {@link ConstructorResult} annotation to map
* a column of the SELECT list of a SPARQL query.
* <p>
* The name element references the name of a variable in the SELECT list. Scalar result types can be included in the
* query result by specifying this annotation in the metadata.
* <p>
* Example:
* <pre>
* <code>
* Query q = em.createNativeQuery("SELECT ?uri ?label ?comment WHERE {" +
* "?uri a <http://onto.fel.cvut.cz/ontologies/jopa/Example> ;" +
* "rdfs:label ?label ;" +
* "rdfs:comment ?comment ." +
* "}", "ExampleResults");
* </code>
* </pre>
* <p>
* <pre>
* <code>
* {@literal @}SparqlResultSetMapping(name="ExampleResults",
* classes={
* {@literal @}ConstructorResult(targetClass=cz.cvut.kbss.jopa.Example, variables={
* {@literal @}VariableResult(name="uri"),
* {@literal @}VariableResult(name="label"),
* {@literal @}VariableResult(name="comment")
* }
* }
* )
* </code>
* </pre>
*/
@Target(value = {})
@Retention(RetentionPolicy.RUNTIME)
public @interface VariableResult {
/**
* (Required) The name of a variable in the SELECT clause of a SPARQL query.
*/
String name();
/**
* (Optional) The Java type to which the variable mapping type is to be mapped.
* <p>
* If the type element is not specified, the default OntoDriver type mapping for the variable mapping will be used.
*/
Class<?> type() default void.class;
}