blob: ef585a1512142c78af8b5a2f0ef94d5f867a4a73 (
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
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
|
/*
* Copyright (c) 2009-2012, 2016 Eike Stepper (Berlin, Germany) and others.
* 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:
* Simon McDuff - initial API and implementation
* Eike Stepper - maintenance
*/
package org.eclipse.emf.cdo.view;
import org.eclipse.emf.cdo.common.CDOCommonRepository;
import org.eclipse.emf.cdo.common.CDOCommonView;
import org.eclipse.emf.cdo.common.util.CDOQueryInfo;
import org.eclipse.net4j.util.collection.CloseableIterator;
import java.util.List;
/**
* Provides access to the information that specifies a query from a {@link CDOCommonView view} to a
* {@link CDOCommonRepository repository} and to the results of the remote query execution;
*
* @author Simon McDuff
* @since 2.0
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
* @apiviz.landmark
* @apiviz.has {@link java.lang.Object} oneway - - context
* @apiviz.composedOf {@link java.util.Map.Entry} - - parameters
* @apiviz.uses {@link java.util.List} - - result
* @apiviz.uses {@link org.eclipse.net4j.util.collection.CloseableIterator} - - resultAsync
*/
public interface CDOQuery extends CDOQueryInfo
{
/**
* Returns the {@link CDOView view} this query was created by and is associated with.
*
* @return Never <code>null</code>.
*/
public CDOView getView();
/**
* Sends this query to the server and returns a typed {@link CloseableIterator iterator} over the query result.
* <p>
* As opposed to the {@link #getResult(Class)} method, this method <b>asynchronously</b> communicates with the server.
* In other words, the returned iterator can be used immediately, even if the server is still about to send pending
* result elements.
*/
public <T> CloseableIterator<T> getResultAsync(Class<T> classObject);
/**
* Same as {@link #getResultAsync(Class)} but tries to infer the return type from the static context.
*
* @since 4.0
*/
public <T> CloseableIterator<T> getResultAsync();
/**
* Sends this query to the server and returns a typed {@link List list} containing the query result.
* <p>
* As opposed to the {@link #getResultAsync(Class)} method, this method <b>synchronously</b> communicates with the
* server. In other words, the result list is only returned after all result elements have been received by the
* client.
*/
public <T> List<T> getResult(Class<T> type);
/**
* Same as {@link #getResult(Class)} but tries to infer the return type from the static context.
*
* @since 4.0
*/
public <T> List<T> getResult();
/**
* @since 4.2
*/
public <T> T getResultValue(Class<T> type);
/**
* @since 4.2
*/
public <T> T getResultValue();
/**
* Sets the maximum number of results to retrieve from the server.
*
* @param maxResults
* the maximum number of results to retrieve or {@link #UNLIMITED_RESULTS} for no limitation.
* @return the same query instance.
*/
public CDOQuery setMaxResults(int maxResults);
/**
* Binds an argument value to a named parameter.
*
* @param name
* the parameter name
* @param value
* the value to bind
* @return the same query instance
* @throws IllegalArgumentException
* if the parameter name does not correspond to a parameter in the query string or if the argument value is
* of incorrect type
*/
public CDOQuery setParameter(String name, Object value);
/**
* Removes the value of a named parameter.
*
* @param name
* the parameter name
* @return the same query instance
* @since 4.6
*/
public CDOQuery unsetParameter(String name);
/**
* Binds an object as the context for this query.
*
* @since 4.0
*/
public CDOQuery setContext(Object object);
}
|
