-
Notifications
You must be signed in to change notification settings - Fork 14
/
SparqlResultSetMapping.java
78 lines (71 loc) · 2.46 KB
/
SparqlResultSetMapping.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
/**
* 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 cz.cvut.kbss.jopa.model.query.Query;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Specifies the mapping of the result of a native SPARQL query.
* <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>
*
* @see Query
* @see NamedNativeQuery
*/
@Target(value = ElementType.TYPE)
@Retention(value = RetentionPolicy.RUNTIME)
public @interface SparqlResultSetMapping {
/**
* The name given to the result set mapping and used to refer to it in the methods of the {@link Query} API.
*/
String name();
/**
* Specifies the result set mapping to constructors.
*/
ConstructorResult[] classes() default {};
/**
* Specifies the result set mapping to entities.
*/
EntityResult[] entities() default {};
/**
* Specifies the result set mapping to scalar values.
*/
VariableResult[] variables() default {};
}