blob: c6829d95c394413020bf3ce1ea5c91809c8abcd7 (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2007, 2011 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0, which accompanies this distribution
* and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.jpa.core.context;
import java.util.Arrays;
import org.eclipse.jpt.common.utility.internal.iterables.ListIterable;
import org.eclipse.jpt.jpa.core.context.java.JavaQuery;
import org.eclipse.jpt.jpa.core.context.orm.OrmQuery;
/**
* Named and named native queries.
* <p>
* Queries can be defined on<ul>
* <li>Java and <code>orm.xml</code> entities
* <li>Java (<em>only</em>) mapped superclasses
* <li><code>orm.xml</code> entity mappings elements
* </ul>
* <p>
* Provisional API: This interface is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*
* @version 2.2
* @since 2.0
*/
public interface Query
extends JpaNamedContextNode<Query>
{
/**
* TODO use this precedence until adopters protest...
* then move to JpaPlatform
*/
@SuppressWarnings("unchecked")
Iterable<Class<? extends Query>> PRECEDENCE_TYPE_LIST = Arrays.asList(
OrmQuery.class,
JavaQuery.class
);
// ********** query **********
String QUERY_PROPERTY = "query"; //$NON-NLS-1$
String getQuery();
void setQuery(String query);
// ********** hints **********
String HINTS_LIST = "hints"; //$NON-NLS-1$
/**
* Return the query's hints.
*/
ListIterable<? extends QueryHint> getHints();
/**
* Return the number of hints.
*/
int getHintsSize();
/**
* Add a hint to the query and return the object representing it.
*/
QueryHint addHint();
/**
* Add a hint to the query and return the object representing it.
*/
QueryHint addHint(int index);
/**
* Remove the hint at the index from the query.
*/
void removeHint(QueryHint queryHint);
/**
* Remove the hint from the query.
*/
void removeHint(int index);
/**
* Move the hint from the source index to the target index.
*/
void moveHint(int targetIndex, int sourceIndex);
}
|
