summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html
blob: e8418031de5272b0c664c2ff983568342c17670c (plain)
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:44 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>IndexedQueryExecutor.Support (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="IndexedQueryExecutor.Support (Carbonado 1.2.3 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IndexedQueryExecutor.Support.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li>
<li><a href="IndexedQueryExecutor.Support.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.amazon.carbonado.qe</div>
<h2 title="Interface IndexedQueryExecutor.Support" class="title">Interface IndexedQueryExecutor.Support&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a>&lt;S&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="strong">IndexedQueryExecutor.Support&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</span></pre>
<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index,
                        <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a>&lt;?&gt;&nbsp;indexEntryQuery)</code>
<div class="block">Fetch Storables referenced by the given index entry query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index,
                        <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a>&lt;?&gt;&nbsp;indexEntryQuery,
                        <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>&nbsp;controller)</code>
<div class="block">Fetch Storables referenced by the given index entry query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index,
           java.lang.Object[]&nbsp;identityValues,
           <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>&nbsp;rangeStartBoundary,
           java.lang.Object&nbsp;rangeStartValue,
           <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>&nbsp;rangeEndBoundary,
           java.lang.Object&nbsp;rangeEndValue,
           boolean&nbsp;reverseRange,
           boolean&nbsp;reverseOrder)</code>
<div class="block">Perform an index scan of a subset of Storables referenced by an
 index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index,
           java.lang.Object[]&nbsp;identityValues,
           <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>&nbsp;rangeStartBoundary,
           java.lang.Object&nbsp;rangeStartValue,
           <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>&nbsp;rangeEndBoundary,
           java.lang.Object&nbsp;rangeEndValue,
           boolean&nbsp;reverseRange,
           boolean&nbsp;reverseOrder,
           <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>&nbsp;controller)</code>
<div class="block">Perform an index scan of a subset of Storables referenced by an
 index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a>&lt;?&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index)</code>
<div class="block">Returns an open query if the given index supports query access.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexEntryQuery</h4>
<pre><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a>&lt;?&gt;&nbsp;indexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index)
                         throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns an open query if the given index supports query access. If
 not supported, return null. An index entry query might be used to
 perform filtering and sorting of index entries prior to being
 resolved into referenced Storables.

 <p>If an index entry query is returned, the fetchSubset method is
 never called by IndexedQueryExecutor.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>index entry query or null if not supported</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt>
  <dd>1.2</dd></dl>
</li>
</ul>
<a name="fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchFromIndexEntryQuery</h4>
<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;fetchFromIndexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index,
                                 <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a>&lt;?&gt;&nbsp;indexEntryQuery)
                                                    throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Fetch Storables referenced by the given index entry query. This
 method is only called if index supports query access.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open</dd><dd><code>indexEntryQuery</code> - query with no blank parameters, derived from
 the query returned by indexEntryQuery</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt>
  <dd>1.2</dd></dl>
</li>
</ul>
<a name="fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchFromIndexEntryQuery</h4>
<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;fetchFromIndexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index,
                                 <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a>&lt;?&gt;&nbsp;indexEntryQuery,
                                 <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>&nbsp;controller)
                                                    throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Fetch Storables referenced by the given index entry query. This
 method is only called if index supports query access.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open</dd><dd><code>indexEntryQuery</code> - query with no blank parameters, derived from
 the query returned by indexEntryQuery</dd><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd><dt><span class="strong">Since:</span></dt>
  <dd>1.2</dd></dl>
</li>
</ul>
<a name="fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchSubset</h4>
<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;fetchSubset(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index,
                    java.lang.Object[]&nbsp;identityValues,
                    <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>&nbsp;rangeStartBoundary,
                    java.lang.Object&nbsp;rangeStartValue,
                    <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>&nbsp;rangeEndBoundary,
                    java.lang.Object&nbsp;rangeEndValue,
                    boolean&nbsp;reverseRange,
                    boolean&nbsp;reverseOrder)
                                       throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Perform an index scan of a subset of Storables referenced by an
 index. The identity values are aligned with the index properties at
 property 0. An optional range start or range end aligns with the index
 property following the last of the identity values.

 <p>This method is only called if no index entry query was provided
 for the given index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - optional list of exactly matching values to apply to index</dd><dd><code>rangeStartBoundary</code> - start boundary type</dd><dd><code>rangeStartValue</code> - value to start at if boundary is not open</dd><dd><code>rangeEndBoundary</code> - end boundary type</dd><dd><code>rangeEndValue</code> - value to end at if boundary is not open</dd><dd><code>reverseRange</code> - indicates that range operates on a property whose
 natural order is descending. Only the code that opens the physical
 cursor should examine this parameter. If true, then the range start and
 end parameter pairs need to be swapped.</dd><dd><code>reverseOrder</code> - when true, iteration should be reversed from its
 natural order</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
<a name="fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fetchSubset</h4>
<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;fetchSubset(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a>&lt;<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>&gt;&nbsp;index,
                    java.lang.Object[]&nbsp;identityValues,
                    <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>&nbsp;rangeStartBoundary,
                    java.lang.Object&nbsp;rangeStartValue,
                    <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>&nbsp;rangeEndBoundary,
                    java.lang.Object&nbsp;rangeEndValue,
                    boolean&nbsp;reverseRange,
                    boolean&nbsp;reverseOrder,
                    <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>&nbsp;controller)
                                       throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Perform an index scan of a subset of Storables referenced by an
 index. The identity values are aligned with the index properties at
 property 0. An optional range start or range end aligns with the index
 property following the last of the identity values.

 <p>This method is only called if no index entry query was provided
 for the given index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - optional list of exactly matching values to apply to index</dd><dd><code>rangeStartBoundary</code> - start boundary type</dd><dd><code>rangeStartValue</code> - value to start at if boundary is not open</dd><dd><code>rangeEndBoundary</code> - end boundary type</dd><dd><code>rangeEndValue</code> - value to end at if boundary is not open</dd><dd><code>reverseRange</code> - indicates that range operates on a property whose
 natural order is descending. Only the code that opens the physical
 cursor should examine this parameter. If true, then the range start and
 end parameter pairs need to be swapped.</dd><dd><code>reverseOrder</code> - when true, iteration should be reversed from its
 natural order</dd><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IndexedQueryExecutor.Support.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li>
<li><a href="IndexedQueryExecutor.Support.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>