Package: NamedNativeQuery

NamedNativeQuery

Coverage

1: /*
2: * JOPA
3: * Copyright (C) 2024 Czech Technical University in Prague
4: *
5: * This library is free software; you can redistribute it and/or
6: * modify it under the terms of the GNU Lesser General Public
7: * License as published by the Free Software Foundation; either
8: * version 3.0 of the License, or (at your option) any later version.
9: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library.
17: */
18: package cz.cvut.kbss.jopa.model.annotations;
19:
20: import java.lang.annotation.ElementType;
21: import java.lang.annotation.Retention;
22: import java.lang.annotation.RetentionPolicy;
23: import java.lang.annotation.Target;
24:
25: /**
26: * Specifies a named native SPARQL query.
27: * <p>
28: * Query names are scoped to the persistence unit. The NamedNativeQuery annotation can be applied to an entity or mapped
29: * superclass.
30: */
31: @Target(ElementType.TYPE)
32: @Retention(RetentionPolicy.RUNTIME)
33: public @interface NamedNativeQuery {
34:
35: /**
36: * The name used to refer to the query with the {@link cz.cvut.kbss.jopa.model.EntityManager} methods that create
37: * query objects.
38: *
39: * @return Name of the query
40: */
41: String name();
42:
43: /**
44: * The SPARQL query string.
45: *
46: * @return The query
47: */
48: String query();
49: }