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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
|
<!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:40 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Query (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="Query (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/Query.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/PrimaryKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/amazon/carbonado/Query.html" target="_top">Frames</a></li>
<li><a href="Query.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: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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</div>
<h2 title="Interface Query" class="title">Interface Query<S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a>, <a href="../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a>, <a href="../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Query<S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre>
<div class="block">Supports complex retrieval and deletion of <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> objects.
Queries are immutable representations of an action – they do not
contain any Storable instances. The apparent mutators (with, et al) do not
actually modify the Query. Instead, they return another Query instance which
has the requested modification. To obtain an initial Query instance, call
one of the <a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a> query methods.
<p>Query objects are usually compiled and cached, and the same instance can
be re-used for future queries. This is possible because queries are
immutable and naturally thread-safe.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Brian S O'Neill</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface </code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></strong></code>
<div class="block">Controller instance can be used to abort query operations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></strong></code>
<div class="block">Timeout controller, for aborting long running queries.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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"> </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><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#after(T)">after</a></strong>(T start)</code>
<div class="block">Returns a query which fetches results for this query after a given
starting point, which is useful for re-opening a cursor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code>
<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of
results.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#and(java.lang.String)">and</a></strong>(java.lang.String filter)</code>
<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of
results.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#count()">count</a></strong>()</code>
<div class="block">Returns a count of all results matched by this query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Returns a count of all results matched by this query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#deleteAll()">deleteAll</a></strong>()</code>
<div class="block">Deletes zero or more matching objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Deletes zero or more matching objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#deleteOne()">deleteOne</a></strong>()</code>
<div class="block">Deletes one matching object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Deletes one matching object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#exists()">exists</a></strong>()</code>
<div class="block">Returns true if any results are matched by this query.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Returns true if any results are matched by this 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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetch()">fetch</a></strong>()</code>
<div class="block">Fetches results for this 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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Fetches results for this query.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetchAfter(T)">fetchAfter</a></strong>(T start)</code>
<div class="block">Fetches results for this query after a given starting point, which is
useful for re-opening a cursor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start,
<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Fetches results for this query after a given starting point, which is
useful for re-opening a cursor.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from,
java.lang.Long to)</code>
<div class="block">Fetches a slice of results for this query, as defined by a numerical
range.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from,
java.lang.Long to,
<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Fetches a slice of results for this query, as defined by a numerical
range.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#getBlankParameterCount()">getBlankParameterCount</a></strong>()</code>
<div class="block">Returns the amount of blank parameters that need to be filled in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#getFilter()">getFilter</a></strong>()</code>
<div class="block">Returns the query's filter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues</a></strong>()</code>
<div class="block">Returns the query's filter values, which is null if filter has no
parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class<<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#getStorableType()">getStorableType</a></strong>()</code>
<div class="block">Returns the specific type of Storable managed by this object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#hashCode()">hashCode</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#loadOne()">loadOne</a></strong>()</code>
<div class="block">Attempts to load exactly one matching object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Attempts to load exactly one matching object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#not()">not</a></strong>()</code>
<div class="block">Returns a new query which produces all the results not supplied in this
query.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code>
<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of
results.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#or(java.lang.String)">or</a></strong>(java.lang.String filter)</code>
<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of
results.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code>
<div class="block">Returns a copy of this query ordered by specific property values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code>
<div class="block">Returns a copy of this query ordered by a specific property value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printNative()">printNative</a></strong>()</code>
<div class="block">Print the native query to standard out, which is useful for performance
analysis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable)">printNative</a></strong>(java.lang.Appendable app)</code>
<div class="block">Prints the native query to any appendable, which is useful for
performance analysis.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable, int)">printNative</a></strong>(java.lang.Appendable app,
int indentLevel)</code>
<div class="block">Prints the native query to any appendable, which is useful for
performance analysis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printPlan()">printPlan</a></strong>()</code>
<div class="block">Prints the query excecution plan to standard out, which is useful for
performance analysis.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable)">printPlan</a></strong>(java.lang.Appendable app)</code>
<div class="block">Prints the query excecution plan to any appendable, which is useful for
performance analysis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable, int)">printPlan</a></strong>(java.lang.Appendable app,
int indentLevel)</code>
<div class="block">Prints the query excecution plan to any appendable, which is useful for
performance analysis.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a description of the query filter and any other arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#tryDeleteOne()">tryDeleteOne</a></strong>()</code>
<div class="block">Deletes zero or one matching objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Deletes zero or one matching objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#tryLoadOne()">tryLoadOne</a></strong>()</code>
<div class="block">Tries to load one record, but returns null if nothing was found.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Tries to load one record, but returns null if nothing was found.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(boolean)">with</a></strong>(boolean value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(byte)">with</a></strong>(byte value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(char)">with</a></strong>(char value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(double)">with</a></strong>(double value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(float)">with</a></strong>(float value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(int)">with</a></strong>(int value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(long)">with</a></strong>(long value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(short)">with</a></strong>(short value)</code>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</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><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code>
<div class="block">Returns a copy of this Query with the next blank parameters filled in.</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="getStorableType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStorableType</h4>
<pre>java.lang.Class<<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> getStorableType()</pre>
<div class="block">Returns the specific type of Storable managed by this object.</div>
</li>
</ul>
<a name="getFilter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre><a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> getFilter()</pre>
<div class="block">Returns the query's filter.</div>
</li>
</ul>
<a name="getFilterValues()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterValues</h4>
<pre><a href="../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> getFilterValues()</pre>
<div class="block">Returns the query's filter values, which is null if filter has no
parameters.</div>
</li>
</ul>
<a name="getBlankParameterCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlankParameterCount</h4>
<pre>int getBlankParameterCount()</pre>
<div class="block">Returns the amount of blank parameters that need to be filled in. If
zero, then this query is ready to be used.</div>
</li>
</ul>
<a name="with(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(int value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="with(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(long value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="with(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(float value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="with(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(double value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="with(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(boolean value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="with(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(char value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="with(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(byte value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="with(short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(short value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="with(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>with</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(java.lang.Object value)</pre>
<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl>
</li>
</ul>
<a name="withValues(java.lang.Object...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withValues</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> withValues(java.lang.Object... values)</pre>
<div class="block">Returns a copy of this Query with the next blank parameters filled in.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - parameter values to fill in; if null or empty, this
Query instance is returned</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if no blank parameters or if too many
parameter values supplied</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if any type doesn't match</dd></dl>
</li>
</ul>
<a name="and(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>and</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> and(java.lang.String filter)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of
results.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter expression</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> - if storage layer throws an exception</dd>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query, or
if this query is already guaranteed to fetch nothing</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd>
<dd><code><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></code> - if expression is malformed</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl>
</li>
</ul>
<a name="and(com.amazon.carbonado.filter.Filter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>and</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> and(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of
results.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</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> - if storage layer throws an exception</dd>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query, or
if this query is already guaranteed to fetch nothing</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl>
</li>
</ul>
<a name="or(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>or</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> or(java.lang.String filter)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of
results.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter expression</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> - if storage layer throws an exception</dd>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query, or
if this query is already guaranteed to fetch everything</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd>
<dd><code><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></code> - if expression is malformed</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl>
</li>
</ul>
<a name="or(com.amazon.carbonado.filter.Filter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>or</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> or(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of
results.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</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> - if storage layer throws an exception</dd>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query, or
if this query is already guaranteed to fetch everything</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl>
</li>
</ul>
<a name="not()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>not</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> not()
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a new query which produces all the results not supplied in this
query. Any filled in parameters in this query are copied into the new
one.</div>
<dl><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> - if storage layer throws an exception</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if new query is unsupported by repository</dd></dl>
</li>
</ul>
<a name="orderBy(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderBy</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> orderBy(java.lang.String property)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a copy of this query ordered by a specific property value. The
property name may be prefixed with '+' or '-' to indicate ascending or
descending order. If the prefix is omitted, ascending order is assumed.
<p>Note: Specification of ordering properties is not cumulative. Calling
this method will first remove any previous ordering properties.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - name of property to order by</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> - if storage layer throws an exception</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if property is null or is not a member
of type S</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if given ordering, combined with
query filter, is unsupported by repository</dd></dl>
</li>
</ul>
<a name="orderBy(java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderBy</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> orderBy(java.lang.String... properties)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a copy of this query ordered by specific property values. The
property names may be prefixed with '+' or '-' to indicate ascending or
descending order. If the prefix is omitted, ascending order is assumed.
<p>Note: Specification of ordering properties is not cumulative. Calling
this method will first remove any previous ordering properties.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - names of properties to order by</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> - if storage layer throws an exception</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if any property is null or is not a
member of type S</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if given ordering, combined with
query filter, is unsupported by repository</dd></dl>
</li>
</ul>
<a name="after(com.amazon.carbonado.Storable)">
<!-- -->
</a><a name="after(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>after</h4>
<pre><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> after(T start)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a query which fetches results for this query after a given
starting point, which is useful for re-opening a cursor. This is only
effective when query has been given an explicit <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total ordering, then query may start at an earlier
position.
<p>Note: The returned query can be very expensive to fetch from
repeatedly, if the query needs to perform a sort operation. Ideally, the
query ordering should match the natural ordering of an index or key.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, this query is
returned</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="fetch()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetch</h4>
<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetch()
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Fetches results for this query. If any updates or deletes might be
performed on the results, consider enclosing the fetch in a
transaction. This allows the isolation level and "for update" mode to be
adjusted. Some repositories might otherwise deadlock.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>fetch results</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a></dd></dl>
</li>
</ul>
<a name="fetch(com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetch</h4>
<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetch(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Fetches results for this query. If any updates or deletes might be
performed on the results, consider enclosing the fetch in a
transaction. This allows the isolation level and "for update" mode to be
adjusted. Some repositories might otherwise deadlock.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a></dd></dl>
</li>
</ul>
<a name="fetchSlice(long, java.lang.Long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchSlice</h4>
<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetchSlice(long from,
java.lang.Long to)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Fetches a slice of results for this query, as defined by a numerical
range. A slice can be used to limit the number of results from a
query. It is strongly recommended that the query be given a total <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a> in order for the slice results to be deterministic.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd>
<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>from</code> is negative or if
<code>from</code> is more than <code>to</code></dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchSlice</h4>
<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetchSlice(long from,
java.lang.Long to,
<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Fetches a slice of results for this query, as defined by a numerical
range. A slice can be used to limit the number of results from a
query. It is strongly recommended that the query be given a total <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a> in order for the slice results to be deterministic.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>from</code> is negative or if
<code>from</code> is more than <code>to</code></dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="fetchAfter(com.amazon.carbonado.Storable)">
<!-- -->
</a><a name="fetchAfter(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchAfter</h4>
<pre><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetchAfter(T start)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Fetches results for this query after a given starting point, which is
useful for re-opening a cursor. This is only effective when query has
been given an explicit <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total
ordering, then cursor may start at an earlier position.
<p>Note: This method can be very expensive to call repeatedly, if the
query needs to perform a sort operation. Ideally, the query ordering
should match the natural ordering of an index or key.
<p>Calling <code>fetchAfter(s)</code> is equivalent to calling <code>after(s).fetch()</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, fetch all results</dd>
<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>,
<a href="../../../com/amazon/carbonado/Query.html#after(T)"><code>after(T)</code></a></dd></dl>
</li>
</ul>
<a name="fetchAfter(com.amazon.carbonado.Storable,com.amazon.carbonado.Query.Controller)">
<!-- -->
</a><a name="fetchAfter(T, com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchAfter</h4>
<pre><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetchAfter(T start,
<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Fetches results for this query after a given starting point, which is
useful for re-opening a cursor. This is only effective when query has
been given an explicit <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total
ordering, then cursor may start at an earlier position.
<p>Note: This method can be very expensive to call repeatedly, if the
query needs to perform a sort operation. Ideally, the query ordering
should match the natural ordering of an index or key.
<p>Calling <code>fetchAfter(s)</code> is equivalent to calling <code>after(s).fetch()</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, fetch all results</dd><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>,
<a href="../../../com/amazon/carbonado/Query.html#after(T)"><code>after(T)</code></a></dd></dl>
</li>
</ul>
<a name="loadOne()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadOne</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> loadOne()
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Attempts to load exactly one matching object. If the number of matching
records is zero or exceeds one, then an exception is thrown instead.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a single fetched object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="loadOne(com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadOne</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> loadOne(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Attempts to load exactly one matching object. If the number of matching
records is zero or exceeds one, then an exception is thrown instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Returns:</span></dt><dd>a single fetched object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="tryLoadOne()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryLoadOne</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> tryLoadOne()
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Tries to load one record, but returns null if nothing was found. Throws
exception if record count is more than one.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>null or a single fetched object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="tryLoadOne(com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryLoadOne</h4>
<pre><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> tryLoadOne(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Tries to load one record, but returns null if nothing was found. Throws
exception if record count is more than one.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Returns:</span></dt><dd>null or a single fetched object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="deleteOne()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteOne</h4>
<pre>void deleteOne()
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">Deletes one matching object. If the number of matching records is zero or
exceeds one, then no delete occurs, and an exception is thrown instead.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="deleteOne(com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteOne</h4>
<pre>void deleteOne(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">Deletes one matching object. If the number of matching records is zero or
exceeds one, then no delete occurs, and an exception is thrown instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="tryDeleteOne()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryDeleteOne</h4>
<pre>boolean tryDeleteOne()
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">Deletes zero or one matching objects. If the number of matching records
exceeds one, then no delete occurs, and an exception is thrown instead.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="tryDeleteOne(com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryDeleteOne</h4>
<pre>boolean tryDeleteOne(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">Deletes zero or one matching objects. If the number of matching records
exceeds one, then no delete occurs, and an exception is thrown instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="deleteAll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAll</h4>
<pre>void deleteAll()
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">Deletes zero or more matching objects. There is no guarantee that
deleteAll is an atomic operation. If atomic behavior is desired, wrap
the call in a transaction scope.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="deleteAll(com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteAll</h4>
<pre>void deleteAll(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre>
<div class="block">Deletes zero or more matching objects. There is no guarantee that
deleteAll is an atomic operation. If atomic behavior is desired, wrap
the call in a transaction scope.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="count()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>long count()
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a count of all results matched by this query. Even though no
results are explicitly fetched, this method may still be expensive to
call. The actual performance will vary by repository and available indexes.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>count of matches</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="count(com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>long count(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns a count of all results matched by this query. Even though no
results are explicitly fetched, this method may still be expensive to
call. The actual performance will vary by repository and available indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Returns:</span></dt><dd>count of matches</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="exists()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exists</h4>
<pre>boolean exists()
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns true if any results are matched by this query.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if any matches</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="exists(com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exists</h4>
<pre>boolean exists(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)
throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block">Returns true if any results are matched by this query.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if any matches</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd>
<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="printNative()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printNative</h4>
<pre>boolean printNative()</pre>
<div class="block">Print the native query to standard out, which is useful for performance
analysis. Not all repositories have a native query format. An example
native format is SQL.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl>
</li>
</ul>
<a name="printNative(java.lang.Appendable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printNative</h4>
<pre>boolean printNative(java.lang.Appendable app)
throws java.io.IOException</pre>
<div class="block">Prints the native query to any appendable, which is useful for
performance analysis. Not all repositories have a native query
format. An example native format is SQL.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd>
<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="printNative(java.lang.Appendable, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printNative</h4>
<pre>boolean printNative(java.lang.Appendable app,
int indentLevel)
throws java.io.IOException</pre>
<div class="block">Prints the native query to any appendable, which is useful for
performance analysis. Not all repositories have a native query
format. An example native format is SQL.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd>
<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="printPlan()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printPlan</h4>
<pre>boolean printPlan()</pre>
<div class="block">Prints the query excecution plan to standard out, which is useful for
performance analysis. There is no standard format for query plans, nor
is it a requirement that this method be implemented.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl>
</li>
</ul>
<a name="printPlan(java.lang.Appendable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printPlan</h4>
<pre>boolean printPlan(java.lang.Appendable app)
throws java.io.IOException</pre>
<div class="block">Prints the query excecution plan to any appendable, which is useful for
performance analysis. There is no standard format for query plans, nor
is it a requirement that this method be implemented.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd>
<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="printPlan(java.lang.Appendable, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printPlan</h4>
<pre>boolean printPlan(java.lang.Appendable app,
int indentLevel)
throws java.io.IOException</pre>
<div class="block">Prints the query excecution plan to any appendable, which is useful for
performance analysis. There is no standard format for query plans, nor
is it a requirement that this method be implemented.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd>
<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>int hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>boolean equals(java.lang.Object obj)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>java.lang.String toString()</pre>
<div class="block">Returns a description of the query filter and any other arguments.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</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/Query.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/PrimaryKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/amazon/carbonado/Query.html" target="_top">Frames</a></li>
<li><a href="Query.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: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>
|
