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
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
|
<!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_60) on Tue Feb 17 12:25:55 EST 2015 -->
<title>SecondaryIndex (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2015-02-17">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SecondaryIndex (Oracle - Berkeley DB Java 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/SecondaryIndex.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-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/persist/SecondaryIndex.html" target="_top">Frames</a></li>
<li><a href="SecondaryIndex.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>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.sleepycat.persist</div>
<h2 title="Class SecondaryIndex" class="title">Class SecondaryIndex<SK,PK,E></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.persist.SecondaryIndex<SK,PK,E></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><SK,E></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SecondaryIndex<SK,PK,E></span>
extends java.lang.Object</pre>
<div class="block">The secondary index for an entity class and a secondary key.
<p><code>SecondaryIndex</code> objects are thread-safe. Multiple threads may
safely call the methods of a shared <code>SecondaryIndex</code> object.</p>
<p><code>SecondaryIndex</code> implements <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a> to map the
secondary key type (SK) to the entity type (E). In other words, entities
are accessed by secondary key values.</p>
<p>The <a href="../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><code>SecondaryKey</code></a> annotation may be used to define a secondary key
as shown in the following example.</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=MANY_TO_ONE)
String department;
String name;
private Employee() {}
}</pre>
<p>Before obtaining a <code>SecondaryIndex</code>, the <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> must
be obtained for the entity class. To obtain the <code>SecondaryIndex</code> call
<a href="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20java.lang.String)"><code>EntityStore.getSecondaryIndex</code></a>, passing
the primary index, the secondary key class and the secondary key name. For
example:</p>
<pre class="code">
EntityStore store = new EntityStore(...);
<code>PrimaryIndex<Long, Employee></code> primaryIndex =
store.getPrimaryIndex(Long.class, Employee.class);
<code>SecondaryIndex<String, Long, Employee></code> secondaryIndex =
store.getSecondaryIndex(primaryIndex, String.class, "department");</pre>
<p>Since <code>SecondaryIndex</code> implements the <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a>
interface, it shares the common index methods for retrieving and deleting
entities, opening cursors and using transactions. See <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a>
for more information on these topics.</p>
<p><code>SecondaryIndex</code> does <em>not</em> provide methods for inserting
and updating entities. That must be done using the <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>.</p>
<p>Note that a <code>SecondaryIndex</code> has three type parameters <code><SK,
PK, E></code> or in the example <code><String, Long, Employee></code> while a <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> has only two type parameters <code><PK, E></code> or <code><Long,
Employee></code>. This is because a <code>SecondaryIndex</code> has an extra level of
mapping: It maps from secondary key to primary key, and then from primary
key to entity. For example, consider this entity:</p>
<p><table class="code" border="1">
<tr><th>ID</th><th>Department</th><th>Name</th></tr>
<tr><td>1</td><td>Engineering</td><td>Jane Smith</td></tr>
</table></p>
<p>The <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> maps from id directly to the entity, or from
primary key 1 to the "Jane Smith" entity in the example. The <code>SecondaryIndex</code> maps from department to id, or from secondary key
"Engineering" to primary key 1 in the example, and then uses the <code>PrimaryIndex</code> to map from the primary key to the entity.</p>
<p>Because of this extra type parameter and extra level of mapping, a <code>SecondaryIndex</code> can provide more than one mapping, or view, of the entities
in the primary index. The main mapping of a <code>SecondaryIndex</code> is to
map from secondary key (SK) to entity (E), or in the example, from the
String department key to the Employee entity. The <code>SecondaryIndex</code>
itself, by implementing <code>EntityIndex<SK, E></code>, provides this
mapping.</p>
<p>The second mapping provided by <code>SecondaryIndex</code> is from secondary
key (SK) to primary key (PK), or in the example, from the String department
key to the Long id key. The <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a> method provides this
mapping. When accessing the keys index, the primary key is returned rather
than the entity. When only the primary key is needed and not the entire
entity, using the keys index is less expensive than using the secondary
index because the primary index does not have to be accessed.</p>
<p>The third mapping provided by <code>SecondaryIndex</code> is from primary key
(PK) to entity (E), for the subset of entities having a given secondary key
(SK). This mapping is provided by the <a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><code>subIndex(SK)</code></a> method. A
sub-index is convenient when you are interested in working with the subset
of entities having a particular secondary key value, for example, all
employees in a given department.</p>
<p>All three mappings, along with the mapping provided by the <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>, are shown using example data in the <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a>
interface documentation. See <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a> for more information.</p>
<p>Note that when using an index, keys and values are stored and retrieved
by value not by reference. In other words, if an entity object is stored
and then retrieved, or retrieved twice, each object will be a separate
instance. For example, in the code below the assertion will always
fail.</p>
<pre class="code">
MyKey key = ...;
MyEntity entity1 = index.get(key);
MyEntity entity2 = index.get(key);
assert entity1 == entity2; // always fails!
</pre>
<h3>One-to-One Relationships</h3>
<p>A <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_ONE"><code>ONE_TO_ONE</code></a> relationship, although less
common than other types of relationships, is the simplest type of
relationship. A single entity is related to a single secondary key value.
For example:</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=ONE_TO_ONE)
String ssn;
String name;
private Employee() {}
}
<code>SecondaryIndex<String, Long, Employee></code> employeeBySsn =
store.getSecondaryIndex(primaryIndex, String.class, "ssn");</pre>
<p>With a <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_ONE"><code>ONE_TO_ONE</code></a> relationship, the
secondary key must be unique; in other words, no two entities may have the
same secondary key value. If an attempt is made to store an entity having
the same secondary key value as another existing entity, a <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> will be thrown.</p>
<p>Because the secondary key is unique, it is useful to lookup entities by
secondary key using <a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><code>EntityIndex.get(K)</code></a>. For example:</p>
<pre class="code">
Employee employee = employeeBySsn.get(mySsn);</pre>
<h3>Many-to-One Relationships</h3>
<p>A <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> relationship is the most
common type of relationship. One or more entities is related to a single
secondary key value. For example:</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=MANY_TO_ONE)
String department;
String name;
private Employee() {}
}
<code>SecondaryIndex<String, Long, Employee></code> employeeByDepartment =
store.getSecondaryIndex(primaryIndex, String.class, "department");</pre>
<p>With a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> relationship, the
secondary key is not required to be unique; in other words, more than one
entity may have the same secondary key value. In this example, more than
one employee may belong to the same department.</p>
<p>The most convenient way to access the employees in a given department is
by using a sub-index. For example:</p>
<pre class="code">
<code>EntityIndex<Long, Entity></code> subIndex = employeeByDepartment.subIndex(myDept);
<code>EntityCursor<Employee></code> cursor = subIndex.entities();
try {
for (Employee entity : cursor) {
// Do something with the entity...
}
} finally {
cursor.close();
}</pre>
<h3>One-to-Many Relationships</h3>
<p>In a <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>ONE_TO_MANY</code></a> relationship, a single
entity is related to one or more secondary key values. For example:</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=ONE_TO_MANY)
Set<String> emailAddresses = new HashSet<String>;
String name;
private Employee() {}
}
<code>SecondaryIndex<String, Long, Employee></code> employeeByEmail =
store.getSecondaryIndex(primaryIndex, String.class, "emailAddresses");</pre>
<p>With a <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>ONE_TO_MANY</code></a> relationship, the
secondary key must be unique; in other words, no two entities may have the
same secondary key value. In this example, no two employees may have the
same email address. If an attempt is made to store an entity having the
same secondary key value as another existing entity, a <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> will be thrown.</p>
<p>Because the secondary key is unique, it is useful to lookup entities by
secondary key using <a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><code>EntityIndex.get(K)</code></a>. For example:</p>
<pre class="code">
Employee employee = employeeByEmail.get(myEmailAddress);</pre>
<p>The secondary key field for a <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>ONE_TO_MANY</code></a> relationship must be an array or collection type. To access
the email addresses of an employee, simply access the collection field
directly. For example:</p>
<pre class="code">
Employee employee = primaryIndex.get(1); // Get the entity by primary key
employee.emailAddresses.add(myNewEmail); // Add an email address
primaryIndex.putNoReturn(1, employee); // Update the entity</pre>
<h3>Many-to-Many Relationships</h3>
<p>In a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> relationship, one
or more entities is related to one or more secondary key values. For
example:</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=MANY_TO_MANY)
Set<String> organizations = new HashSet<String>;
String name;
private Employee() {}
}
<code>SecondaryIndex<String, Long, Employee></code> employeeByOrganization =
store.getSecondaryIndex(primaryIndex, String.class, "organizations");</pre>
<p>With a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> relationship, the
secondary key is not required to be unique; in other words, more than one
entity may have the same secondary key value. In this example, more than
one employee may belong to the same organization.</p>
<p>The most convenient way to access the employees in a given organization
is by using a sub-index. For example:</p>
<pre class="code">
<code>EntityIndex<Long, Entity></code> subIndex = employeeByOrganization.subIndex(myOrg);
<code>EntityCursor<Employee></code> cursor = subIndex.entities();
try {
for (Employee entity : cursor) {
// Do something with the entity...
}
} finally {
cursor.close();
}</pre>
<p>The secondary key field for a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> relationship must be an array or collection type. To access
the organizations of an employee, simply access the collection field
directly. For example:</p>
<pre class="code">
Employee employee = primaryIndex.get(1); // Get the entity by primary key
employee.organizations.remove(myOldOrg); // Remove an organization
primaryIndex.putNoReturn(1, employee); // Update the entity</pre>
<h3>Foreign Key Constraints for Related Entities</h3>
<p>In all the examples above the secondary key is treated only as a simple
value, such as a <code>String</code> department field. In many cases, that is
sufficient. But in other cases, you may wish to constrain the secondary
keys of one entity class to be valid primary keys of another entity
class. For example, a Department entity may also be defined:</p>
<pre class="code">
@Entity
class Department {
@PrimaryKey
String name;
String missionStatement;
private Department() {}
}</pre>
<p>You may wish to constrain the department field values of the Employee
class in the examples above to be valid primary keys of the Department
entity class. In other words, you may wish to ensure that the department
field of an Employee will always refer to a valid Department entity.</p>
<p>You can implement this constraint yourself by validating the department
field before you store an Employee. For example:</p>
<pre class="code">
<code>PrimaryIndex<String, Department></code> departmentIndex =
store.getPrimaryIndex(String.class, Department.class);
void storeEmployee(Employee employee) throws DatabaseException {
if (departmentIndex.contains(employee.department)) {
primaryIndex.putNoReturn(employee);
} else {
throw new IllegalArgumentException("Department does not exist: " +
employee.department);
}
}</pre>
<p>Or, instead you could define the Employee department field as a foreign
key, and this validation will be done for you when you attempt to store the
Employee entity. For example:</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Department.class)
String department;
String name;
private Employee() {}
}</pre>
<p>The <code>relatedEntity=Department.class</code> above defines the department
field as a foreign key that refers to a Department entity. Whenever a
Employee entity is stored, its department field value will be checked to
ensure that a Department entity exists with that value as its primary key.
If no such Department entity exists, then a <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> is
thrown, causing the transaction to be aborted (assuming that transactions
are used).</p>
<p>This begs the question: What happens when a Department entity is deleted
while one or more Employee entities have department fields that refer to
the deleted department's primary key? If the department were allowed to be
deleted, the foreign key constraint for the Employee department field would
be violated, because the Employee department field would refer to a
department that does not exist.</p>
<p>By default, when this situation arises the system does not allow the
department to be deleted. Instead, a <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> is thrown,
causing the transaction to be aborted. In this case, in order to delete a
department, the department field of all Employee entities must first be
updated to refer to a different existing department, or set to null. This
is the responsibility of the application.</p>
<p>There are two additional ways of handling deletion of a Department
entity. These alternatives are configured using the <a href="../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><code>SecondaryKey.onRelatedEntityDelete()</code></a> annotation property. Setting this
property to <a href="../../../com/sleepycat/persist/model/DeleteAction.html#NULLIFY"><code>DeleteAction.NULLIFY</code></a> causes the Employee department
field to be automatically set to null when the department they refer to is
deleted. This may or may not be desirable, depending on application
policies. For example:</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
<code>@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Department.class,
onRelatedEntityDelete=NULLIFY)</code>
String department;
String name;
private Employee() {}
}</pre>
<p>The <a href="../../../com/sleepycat/persist/model/DeleteAction.html#CASCADE"><code>DeleteAction.CASCADE</code></a> value, on the other hand, causes the
Employee entities to be automatically deleted when the department they refer
to is deleted. This is probably not desirable in this particular example,
but is useful for parent-child relationships. For example:</p>
<pre class="code">
@Entity
class Order {
@PrimaryKey
long id;
String description;
private Order() {}
}
@Entity
class OrderItem {
@PrimaryKey
long id;
<code>@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Order.class,
onRelatedEntityDelete=CASCADE)</code>
long orderId;
String description;
private OrderItem() {}
}</pre>
<p>The OrderItem orderId field refers to its "parent" Order entity. When an
Order entity is deleted, it may be useful to automatically delete its
"child" OrderItem entities.</p>
<p>For more information, see <a href="../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><code>SecondaryKey.onRelatedEntityDelete()</code></a>.</p>
<h3>One-to-Many versus Many-to-One for Related Entities</h3>
<p>When there is a conceptual Many-to-One relationship such as Employee to
Department as illustrated in the examples above, the relationship may be
implemented either as Many-to-One in the Employee class or as One-to-Many in
the Department class.</p>
<p>Here is the Many-to-One approach.</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Department.class)
String department;
String name;
private Employee() {}
}
@Entity
class Department {
@PrimaryKey
String name;
String missionStatement;
private Department() {}
}</pre>
<p>And here is the One-to-Many approach.</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
String name;
private Employee() {}
}
@Entity
class Department {
@PrimaryKey
String name;
String missionStatement;
@SecondaryKey(relate=ONE_TO_MANY, relatedEntity=Employee.class)
Set<Long> employees = new HashSet<Long>;
private Department() {}
}</pre>
<p>Which approach is best? The Many-to-One approach better handles large
number of entities on the to-Many side of the relationship because it
doesn't store a collection of keys as an entity field. With Many-to-One a
Btree is used to store the collection of keys and the Btree can easily
handle very large numbers of keys. With One-to-Many, each time a related
key is added or removed the entity on the One side of the relationship,
along with the complete collection of related keys, must be updated.
Therefore, if large numbers of keys may be stored per relationship,
Many-to-One is recommended.</p>
<p>If the number of entities per relationship is not a concern, then you may
wish to choose the approach that is most natural in your application data
model. For example, if you think of a Department as containing employees
and you wish to modify the Department object each time an employee is added
or removed, then you may wish to store a collection of Employee keys in the
Department object (One-to-Many).</p>
<p>Note that if you have a One-to-Many relationship and there is no related
entity, then you don't have a choice -- you have to use One-to-Many because
there is no entity on the to-Many side of the relationship where a
Many-to-One key could be defined. An example is the Employee to email
addresses relationship discussed above:</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=ONE_TO_MANY)
Set<String> emailAddresses = new HashSet<String>;
String name;
private Employee() {}
}</pre>
<p>For sake of argument imagine that each employee has thousands of email
addresses and employees frequently add and remove email addresses. To
avoid the potential performance problems associated with updating the
Employee entity every time an email address is added or removed, you could
create an EmployeeEmailAddress entity and use a Many-to-One relationship as
shown below:</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
String name;
private Employee() {}
}
@Entity
class EmployeeEmailAddress {
@PrimaryKey
String emailAddress;
@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Employee.class)
long employeeId;
private EmployeeEmailAddress() {}
}</pre>
<h3>Key Placement with Many-to-Many for Related Entities</h3>
<p>As discussed in the section above, one drawback of a to-Many relationship
(One-to-Many was discussed above and Many-to-Many is discussed here) is that
it requires storing a collection of keys in an entity. Each time a key is
added or removed, the containing entity must be updated. This has potential
performance problems when there are large numbers of entities on the to-Many
side of the relationship, in other words, when there are large numbers of
keys in each secondary key field collection.</p>
<p>If you have a Many-to-Many relationship with a reasonably small number of
entities on one side of the relationship and a large number of entities on
the other side, you can avoid the potential performance problems by defining
the secondary key field on the side with a small number of entities.</p>
<p>For example, in an Employee-to-Organization relationship, the number of
organizations per employee will normally be reasonably small but the number
of employees per organization may be very large. Therefore, to avoid
potential performance problems, the secondary key field should be defined in
the Employee class as shown below.</p>
<pre class="code">
@Entity
class Employee {
@PrimaryKey
long id;
@SecondaryKey(relate=MANY_TO_MANY, relatedEntity=Organization.class)
Set<String> organizations = new HashSet<String>;
String name;
private Employee() {}
}
@Entity
class Organization {
@PrimaryKey
String name;
String description;
}</pre>
<p>If instead a <code>Set<Long> members</code> key had been defined in the
Organization class, this set could potentially have a large number of
elements and performance problems could result.</p>
<h3>Many-to-Many Versus a Relationship Entity</h3>
<p>If you have a Many-to-Many relationship with a large number of entities
on <em>both</em> sides of the relationship, you can avoid the potential
performance problems by using a <em>relationship entity</em>. A
relationship entity defines the relationship between two other entities
using two Many-to-One relationships.</p>
<p>Imagine a relationship between cars and trucks indicating whenever a
particular truck was passed on the road by a particular car. A given car
may pass a large number of trucks and a given truck may be passed by a large
number of cars. First look at a Many-to-Many relationship between these two
entities:</p>
<pre class="code">
@Entity
class Car {
@PrimaryKey
String licenseNumber;
@SecondaryKey(relate=MANY_TO_MANY, relatedEntity=Truck.class)
Set<String> trucksPassed = new HashSet<String>;
String color;
private Car() {}
}
@Entity
class Truck {
@PrimaryKey
String licenseNumber;
int tons;
private Truck() {}
}</pre>
<p>With the Many-to-Many approach above, the <code>trucksPassed</code> set could
potentially have a large number of elements and performance problems could
result.</p>
<p>To apply the relationship entity approach we define a new entity class
named CarPassedTruck representing a single truck passed by a single car. We
remove the secondary key from the Car class and use two secondary keys in
the CarPassedTruck class instead.</p>
<pre class="code">
@Entity
class Car {
@PrimaryKey
String licenseNumber;
String color;
private Car() {}
}
@Entity
class Truck {
@PrimaryKey
String licenseNumber;
int tons;
private Truck() {}
}
@Entity
class CarPassedTruck {
@PrimaryKey
long id;
@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Car.class)
String carLicense;
@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Truck.class)
String truckLicense;
private CarPassedTruck() {}
}</pre>
<p>The CarPassedTruck entity can be used to access the relationship by car
license or by truck license.</p>
<p>You may use the relationship entity approach because of the potential
performance problems mentioned above. Or, you may choose to use this
approach in order to store other information about the relationship. For
example, if for each car that passes a truck you wish to record how much
faster the car was going than the truck, then a relationship entity is the
logical place to store that property. In the example below the
speedDifference property is added to the CarPassedTruck class.</p>
<pre class="code">
@Entity
class CarPassedTruck {
@PrimaryKey
long id;
@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Car.class)
String carLicense;
@SecondaryKey(relate=MANY_TO_ONE, relatedEntity=Truck.class)
String truckLicense;
int speedDifference;
private CarPassedTruck() {}
}</pre>
<p>Be aware that the relationship entity approach adds overhead compared to
Many-to-Many. There is one additional entity and one additional secondary
key. These factors should be weighed against its advantages and the
relevant application access patterns should be considered.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#SecondaryIndex(com.sleepycat.db.SecondaryDatabase,%20com.sleepycat.db.Database,%20com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20com.sleepycat.bind.EntryBinding)">SecondaryIndex</a></strong>(<a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> database,
<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> keysDatabase,
<a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> primaryIndex,
java.lang.Class<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> secondaryKeyClass,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> secondaryKeyBinding)</code>
<div class="block">Creates a secondary index without using an <code>EntityStore</code>.</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#contains(K)">contains</a></strong>(K key)</code>
<div class="block">Checks for existence of a key in this index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#contains(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">contains</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
K key,
<a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code>
<div class="block">Checks for existence of a key in this index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#count()">count</a></strong>()</code>
<div class="block">Returns a non-transactional count of the entities in this index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#delete(K)">delete</a></strong>(K key)</code>
<div class="block">Deletes all entities with a given index key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#delete(com.sleepycat.db.Transaction,%20K)">delete</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
K key)</code>
<div class="block">Deletes all entities with a given index key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#entities()">entities</a></strong>()</code>
<div class="block">Opens a cursor for traversing all entities in this index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#entities(K,%20boolean,%20K,%20boolean)">entities</a></strong>(K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive)</code>
<div class="block">Opens a cursor for traversing entities in a key range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#entities(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">entities</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
<a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code>
<div class="block">Opens a cursor for traversing all entities in this index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#entities(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">entities</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive,
<a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code>
<div class="block">Opens a cursor for traversing entities in a key range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#get(SK)">get</a></strong>(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key)</code>
<div class="block">Gets an entity via a key of this index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#get(com.sleepycat.db.Transaction,%20SK,%20com.sleepycat.db.LockMode)">get</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key,
<a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code>
<div class="block">Gets an entity via a key of this index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getDatabase()">getDatabase</a></strong>()</code>
<div class="block">Returns the underlying secondary database for this index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeyBinding()">getKeyBinding</a></strong>()</code>
<div class="block">Returns the secondary key binding for the index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Class<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeyClass()">getKeyClass</a></strong>()</code>
<div class="block">Returns the secondary key class for this index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()">getKeysDatabase</a></strong>()</code>
<div class="block">Returns the underlying secondary database that is not associated with
the primary database and is used for the <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getPrimaryIndex()">getPrimaryIndex</a></strong>()</code>
<div class="block">Returns the primary index associated with this secondary index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keys()">keys</a></strong>()</code>
<div class="block">Opens a cursor for traversing all keys in this index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keys(K,%20boolean,%20K,%20boolean)">keys</a></strong>(K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive)</code>
<div class="block">Opens a cursor for traversing keys in a key range.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keys(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">keys</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
<a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code>
<div class="block">Opens a cursor for traversing all keys in this index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keys(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">keys</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive,
<a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code>
<div class="block">Opens a cursor for traversing keys in a key range.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex()">keysIndex</a></strong>()</code>
<div class="block">Returns a read-only keys index that maps secondary key to primary key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Map<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#map()">map</a></strong>()</code>
<div class="block">Returns a standard Java map based on this entity index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.SortedMap<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#sortedMap()">sortedMap</a></strong>()</code>
<div class="block">Returns a standard Java sorted map based on this entity index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)">subIndex</a></strong>(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key)</code>
<div class="block">Returns an index that maps primary key to entity for the subset of
entities having a given secondary key (duplicates).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SecondaryIndex(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.Database, com.sleepycat.persist.PrimaryIndex, java.lang.Class, com.sleepycat.bind.EntryBinding)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SecondaryIndex</h4>
<pre>public SecondaryIndex(<a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> database,
<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> keysDatabase,
<a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> primaryIndex,
java.lang.Class<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> secondaryKeyClass,
<a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> secondaryKeyBinding)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Creates a secondary index without using an <code>EntityStore</code>.
When using an <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a>, call <a href="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20java.lang.String)"><code>getSecondaryIndex</code></a> instead.
<p>This constructor is not normally needed and is provided for
applications that wish to use custom bindings along with the Direct
Persistence Layer. Normally, <a href="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20java.lang.String)"><code>getSecondaryIndex</code></a> is used instead.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>database</code> - the secondary database used for all access other than
via a <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>.</dd><dd><code>keysDatabase</code> - another handle on the secondary database, opened
without association to the primary, and used only for access via a
<a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>. If this argument is null and the <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>
method is called, then the keys database will be opened automatically;
however, the user is then responsible for closing the keys database. To
get the keys database in order to close it, call <a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()"><code>getKeysDatabase()</code></a>.</dd><dd><code>primaryIndex</code> - the primary index associated with this secondary
index.</dd><dd><code>secondaryKeyClass</code> - the class of the secondary key.</dd><dd><code>secondaryKeyBinding</code> - the binding to be used for secondary keys.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDatabase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabase</h4>
<pre>public <a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> getDatabase()</pre>
<div class="block">Returns the underlying secondary database for this index.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the secondary database.</dd></dl>
</li>
</ul>
<a name="getKeysDatabase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeysDatabase</h4>
<pre>public <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> getKeysDatabase()</pre>
<div class="block">Returns the underlying secondary database that is not associated with
the primary database and is used for the <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the keys database.</dd></dl>
</li>
</ul>
<a name="getPrimaryIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrimaryIndex</h4>
<pre>public <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> getPrimaryIndex()</pre>
<div class="block">Returns the primary index associated with this secondary index.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the primary index.</dd></dl>
</li>
</ul>
<a name="getKeyClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyClass</h4>
<pre>public java.lang.Class<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> getKeyClass()</pre>
<div class="block">Returns the secondary key class for this index.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the class.</dd></dl>
</li>
</ul>
<a name="getKeyBinding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeyBinding</h4>
<pre>public <a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> getKeyBinding()</pre>
<div class="block">Returns the secondary key binding for the index.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the key binding.</dd></dl>
</li>
</ul>
<a name="keysIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keysIndex</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>> keysIndex()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Returns a read-only keys index that maps secondary key to primary key.
When accessing the keys index, the primary key is returned rather than
the entity. When only the primary key is needed and not the entire
entity, using the keys index is less expensive than using the secondary
index because the primary index does not have to be accessed.
<p>Note the following in the unusual case that you are <em>not</em>
using an <code>EntityStore</code>: This method will open the keys
database, a second database handle for the secondary database, if it is
not already open. In this case, if you are <em>not</em> using an
<code>EntityStore</code>, then you are responsible for closing the
database returned by <a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()"><code>getKeysDatabase()</code></a> before closing the
environment. If you <em>are</em> using an <code>EntityStore</code>, the
keys database will be closed automatically by <a href="../../../com/sleepycat/persist/EntityStore.html#close()"><code>EntityStore.close()</code></a>.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the keys index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="subIndex(java.lang.Object)">
<!-- -->
</a><a name="subIndex(SK)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subIndex</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> subIndex(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Returns an index that maps primary key to entity for the subset of
entities having a given secondary key (duplicates). A sub-index is
convenient when you are interested in working with the subset of
entities having a particular secondary key value.
<p>When using a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> or <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> secondary key, the sub-index
represents the left (MANY) side of a relationship.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the secondary key that identifies the entities in the
sub-index.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the sub-index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="get(java.lang.Object)">
<!-- -->
</a><a name="get(SK)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a> get(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)">EntityIndex</a></code></strong></div>
<div class="block">Gets an entity via a key of this index.
<p>The operation will not be transaction protected, and <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to search for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value mapped to the given key, or null if the key is not
present in the index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="get(com.sleepycat.db.Transaction,java.lang.Object,com.sleepycat.db.LockMode)">
<!-- -->
</a><a name="get(com.sleepycat.db.Transaction, SK, com.sleepycat.db.LockMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a> get(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key,
<a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#get(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">EntityIndex</a></code></strong></div>
<div class="block">Gets an entity via a key of this index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect this operation, or null
if the operation should not be transaction protected.</dd><dd><code>key</code> - the key to search for.</dd><dd><code>lockMode</code> - the lock mode to use for this operation, or null to
use <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value mapped to the given key, or null if the key is not
present in the index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="map()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>map</h4>
<pre>public java.util.Map<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> map()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#map()">EntityIndex</a></code></strong></div>
<div class="block">Returns a standard Java map based on this entity index. The <a href="../../../com/sleepycat/collections/StoredMap.html" title="class in com.sleepycat.collections"><code>StoredMap</code></a> returned is defined by the <a href="../../../com/sleepycat/collections/package-summary.html">Collections API</a>. Stored collections conform
to the standard Java collections framework interface.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the map.</dd></dl>
</li>
</ul>
<a name="sortedMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortedMap</h4>
<pre>public java.util.SortedMap<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> sortedMap()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#sortedMap()">EntityIndex</a></code></strong></div>
<div class="block">Returns a standard Java sorted map based on this entity index. The
<a href="../../../com/sleepycat/collections/StoredSortedMap.html" title="class in com.sleepycat.collections"><code>StoredSortedMap</code></a> returned is defined by the <a href="../../../com/sleepycat/collections/package-summary.html">Collections API</a>. Stored collections conform
to the standard Java collections framework interface.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the map.</dd></dl>
</li>
</ul>
<a name="contains(java.lang.Object)">
<!-- -->
</a><a name="contains(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public boolean contains(K key)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(K)">EntityIndex</a></code></strong></div>
<div class="block">Checks for existence of a key in this index.
<p>The operation will not be transaction protected, and <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(K)">contains</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to search for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>whether the key exists in the index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="contains(com.sleepycat.db.Transaction,java.lang.Object,com.sleepycat.db.LockMode)">
<!-- -->
</a><a name="contains(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public boolean contains(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
K key,
<a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">EntityIndex</a></code></strong></div>
<div class="block">Checks for existence of a key in this index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">contains</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect this operation, or null
if the operation should not be transaction protected.</dd><dd><code>key</code> - the key to search for.</dd><dd><code>lockMode</code> - the lock mode to use for this operation, or null to
use <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>whether the key exists in the index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="count()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>public long count()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#count()">EntityIndex</a></code></strong></div>
<div class="block">Returns a non-transactional count of the entities in this index.
<p>This operation is faster than obtaining a count by scanning the index
manually, and will not perturb the current contents of the cache.
However, the count is not guaranteed to be accurate if there are
concurrent updates. Note that this method does scan a significant
portion of the index and should be considered a fairly expensive
operation.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#count()">count</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of entities in this index.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="delete(java.lang.Object)">
<!-- -->
</a><a name="delete(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delete</h4>
<pre>public boolean delete(K key)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(K)">EntityIndex</a></code></strong></div>
<div class="block">Deletes all entities with a given index key.
<p>Auto-commit is used implicitly if the store is transactional.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(K)">delete</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to search for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>whether any entities were deleted.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="delete(com.sleepycat.db.Transaction,java.lang.Object)">
<!-- -->
</a><a name="delete(com.sleepycat.db.Transaction, K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delete</h4>
<pre>public boolean delete(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
K key)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction,%20K)">EntityIndex</a></code></strong></div>
<div class="block">Deletes all entities with a given index key.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction,%20K)">delete</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect this operation, null to use
auto-commit, or null if the store is non-transactional.</dd><dd><code>key</code> - the key to search for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>whether any entities were deleted.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="keys()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keys</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K> keys()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys()">EntityIndex</a></code></strong></div>
<div class="block">Opens a cursor for traversing all keys in this index.
<p>The operations performed with the cursor will not be transaction
protected, and <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly. If the
store is transactional, the cursor may not be used to update or delete
entities.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys()">keys</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="keys(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keys</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K> keys(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
<a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">EntityIndex</a></code></strong></div>
<div class="block">Opens a cursor for traversing all keys in this index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">keys</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect all operations performed with
the cursor, or null if the operations should not be transaction
protected. If the store is non-transactional, null must be specified.
For a transactional store the transaction is optional for read-only
access and required for read-write access.</dd><dd><code>config</code> - the cursor configuration that determines the default lock
mode used for all cursor operations, or null to implicitly use <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="entities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entities</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E> entities()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities()">EntityIndex</a></code></strong></div>
<div class="block">Opens a cursor for traversing all entities in this index.
<p>The operations performed with the cursor will not be transaction
protected, and <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly. If the
store is transactional, the cursor may not be used to update or delete
entities.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities()">entities</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="entities(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entities</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E> entities(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
<a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">EntityIndex</a></code></strong></div>
<div class="block">Opens a cursor for traversing all entities in this index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">entities</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect all operations performed with
the cursor, or null if the operations should not be transaction
protected. If the store is non-transactional, null must be specified.
For a transactional store the transaction is optional for read-only
access and required for read-write access.</dd><dd><code>config</code> - the cursor configuration that determines the default lock
mode used for all cursor operations, or null to implicitly use <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="keys(java.lang.Object,boolean,java.lang.Object,boolean)">
<!-- -->
</a><a name="keys(K, boolean, K, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keys</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K> keys(K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(K,%20boolean,%20K,%20boolean)">EntityIndex</a></code></strong></div>
<div class="block">Opens a cursor for traversing keys in a key range.
<p>The operations performed with the cursor will not be transaction
protected, and <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly. If the
store is transactional, the cursor may not be used to update or delete
entities.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(K,%20boolean,%20K,%20boolean)">keys</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>fromKey</code> - is the lower bound of the key range, or null if the range
has no lower bound.</dd><dd><code>fromInclusive</code> - is true if keys greater than or equal to fromKey
should be included in the key range, or false if only keys greater than
fromKey should be included.</dd><dd><code>toKey</code> - is the upper bound of the key range, or null if the range
has no upper bound.</dd><dd><code>toInclusive</code> - is true if keys less than or equal to toKey should be
included in the key range, or false if only keys less than toKey should
be included.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="keys(com.sleepycat.db.Transaction,java.lang.Object,boolean,java.lang.Object,boolean,com.sleepycat.db.CursorConfig)">
<!-- -->
</a><a name="keys(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keys</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K> keys(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive,
<a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">EntityIndex</a></code></strong></div>
<div class="block">Opens a cursor for traversing keys in a key range.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">keys</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect all operations performed with
the cursor, or null if the operations should not be transaction
protected. If the store is non-transactional, null must be specified.
For a transactional store the transaction is optional for read-only
access and required for read-write access.</dd><dd><code>fromKey</code> - is the lower bound of the key range, or null if the range
has no lower bound.</dd><dd><code>fromInclusive</code> - is true if keys greater than or equal to fromKey
should be included in the key range, or false if only keys greater than
fromKey should be included.</dd><dd><code>toKey</code> - is the upper bound of the key range, or null if the range
has no upper bound.</dd><dd><code>toInclusive</code> - is true if keys less than or equal to toKey should be
included in the key range, or false if only keys less than toKey should
be included.</dd><dd><code>config</code> - the cursor configuration that determines the default lock
mode used for all cursor operations, or null to implicitly use <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="entities(java.lang.Object,boolean,java.lang.Object,boolean)">
<!-- -->
</a><a name="entities(K, boolean, K, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entities</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E> entities(K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(K,%20boolean,%20K,%20boolean)">EntityIndex</a></code></strong></div>
<div class="block">Opens a cursor for traversing entities in a key range.
<p>The operations performed with the cursor will not be transaction
protected, and <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly. If the
store is transactional, the cursor may not be used to update or delete
entities.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(K,%20boolean,%20K,%20boolean)">entities</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>fromKey</code> - is the lower bound of the key range, or null if the range
has no lower bound.</dd><dd><code>fromInclusive</code> - is true if keys greater than or equal to fromKey
should be included in the key range, or false if only keys greater than
fromKey should be included.</dd><dd><code>toKey</code> - is the upper bound of the key range, or null if the range
has no upper bound.</dd><dd><code>toInclusive</code> - is true if keys less than or equal to toKey should be
included in the key range, or false if only keys less than toKey should
be included.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl>
</li>
</ul>
<a name="entities(com.sleepycat.db.Transaction,java.lang.Object,boolean,java.lang.Object,boolean,com.sleepycat.db.CursorConfig)">
<!-- -->
</a><a name="entities(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>entities</h4>
<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E> entities(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
K fromKey,
boolean fromInclusive,
K toKey,
boolean toInclusive,
<a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">EntityIndex</a></code></strong></div>
<div class="block">Opens a cursor for traversing entities in a key range.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">entities</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect all operations performed with
the cursor, or null if the operations should not be transaction
protected. If the store is non-transactional, null must be specified.
For a transactional store the transaction is optional for read-only
access and required for read-write access.</dd><dd><code>fromKey</code> - is the lower bound of the key range, or null if the range
has no lower bound.</dd><dd><code>fromInclusive</code> - is true if keys greater than or equal to fromKey
should be included in the key range, or false if only keys greater than
fromKey should be included.</dd><dd><code>toKey</code> - is the upper bound of the key range, or null if the range
has no upper bound.</dd><dd><code>toInclusive</code> - is true if keys less than or equal to toKey should be
included in the key range, or false if only keys less than toKey should
be included.</dd><dd><code>config</code> - the cursor configuration that determines the default lock
mode used for all cursor operations, or null to implicitly use <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</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/SecondaryIndex.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-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/persist/SecondaryIndex.html" target="_top">Frames</a></li>
<li><a href="SecondaryIndex.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>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
|
