mirror of
https://github.com/berkeleydb/je.git
synced 2024-10-03 12:46:57 +00:00
502 lines
25 KiB
HTML
502 lines
25 KiB
HTML
|
<!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 (1.8.0_151) on Tue Oct 31 17:36:46 EDT 2017 -->
|
||
|
|
<title>EntityJoin (Oracle - Berkeley DB Java Edition API)</title>
|
||
|
|
<meta name="date" content="2017-10-31">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
|
||
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<script type="text/javascript"><!--
|
||
|
|
try {
|
||
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
|
parent.document.title="EntityJoin (Oracle - Berkeley DB Java Edition API)";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch(err) {
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
|
||
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
||
|
|
var altColor = "altColor";
|
||
|
|
var rowColor = "rowColor";
|
||
|
|
var tableTab = "tableTab";
|
||
|
|
var activeTableTab = "activeTableTab";
|
||
|
|
</script>
|
||
|
|
<noscript>
|
||
|
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
|
</noscript>
|
||
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
|
<div class="topNav"><a name="navbar.top">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
|
<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/EntityJoin.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"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../com/sleepycat/persist/EntityResult.html" title="class in com.sleepycat.persist"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../index.html?com/sleepycat/persist/EntityJoin.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="EntityJoin.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 EntityJoin" class="title">Class EntityJoin<PK,E></h2>
|
||
|
|
</div>
|
||
|
|
<div class="contentContainer">
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>java.lang.Object</li>
|
||
|
|
<li>
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>com.sleepycat.persist.EntityJoin<PK,E></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<div class="description">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<hr>
|
||
|
|
<br>
|
||
|
|
<pre>public class <span class="typeNameLabel">EntityJoin<PK,E></span>
|
||
|
|
extends java.lang.Object</pre>
|
||
|
|
<div class="block">Performs an equality join on two or more secondary keys.
|
||
|
|
|
||
|
|
<p><code>EntityJoin</code> objects are thread-safe. Multiple threads may safely
|
||
|
|
call the methods of a shared <code>EntityJoin</code> object.</p>
|
||
|
|
|
||
|
|
<p>An equality join is a match on all entities in a given primary index that
|
||
|
|
have two or more specific secondary key values. Note that key ranges may
|
||
|
|
not be matched by an equality join, only exact keys are matched.</p>
|
||
|
|
|
||
|
|
<p>For example:</p>
|
||
|
|
<pre class="code">
|
||
|
|
// Index declarations -- see <a href="package-summary.html#example">package summary example</a>.
|
||
|
|
//
|
||
|
|
PrimaryIndex<String, Person> personBySsn;
|
||
|
|
SecondaryIndex<String, String, Person> personByParentSsn;
|
||
|
|
SecondaryIndex<Long, String, Person> personByEmployerIds;
|
||
|
|
Employer employer = ...;
|
||
|
|
|
||
|
|
// Match on all Person objects having parentSsn "111-11-1111" and also
|
||
|
|
// containing an employerId of employer.id. In other words, match on all
|
||
|
|
// of Bob's children that work for a given employer.
|
||
|
|
//
|
||
|
|
EntityJoin<String, Person> join = new EntityJoin(personBySsn);
|
||
|
|
join.addCondition(personByParentSsn, "111-11-1111");
|
||
|
|
join.addCondition(personByEmployerIds, employer.id);
|
||
|
|
|
||
|
|
// Perform the join operation by traversing the results with a cursor.
|
||
|
|
//
|
||
|
|
ForwardCursor<Person> results = join.entities();
|
||
|
|
try {
|
||
|
|
for (Person person : results) {
|
||
|
|
System.out.println(person.ssn + ' ' + person.name);
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
results.close();
|
||
|
|
}</pre></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
||
|
|
<dd>Mark Hayes</dd>
|
||
|
|
</dl>
|
||
|
|
</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="memberSummary" 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><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityJoin.html#EntityJoin-com.sleepycat.persist.PrimaryIndex-">EntityJoin</a></span>(<a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">PK</a>,<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">E</a>> index)</code>
|
||
|
|
<div class="block">Creates a join object for a given primary index.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
||
|
|
<tr>
|
||
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
|
<th class="colLast" scope="col">Method and Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr id="i0" class="altColor">
|
||
|
|
<td class="colFirst"><code><SK> void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityJoin.html#addCondition-com.sleepycat.persist.SecondaryIndex-SK-">addCondition</a></span>(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist">SecondaryIndex</a><SK,<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">PK</a>,<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">E</a>> index,
|
||
|
|
SK key)</code>
|
||
|
|
<div class="block">Adds a secondary key condition to the equality join.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i1" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">E</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityJoin.html#entities--">entities</a></span>()</code>
|
||
|
|
<div class="block">Opens a cursor that returns the entities qualifying for the join.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i2" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">E</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityJoin.html#entities-com.sleepycat.je.Transaction-com.sleepycat.je.CursorConfig-">entities</a></span>(<a href="../../../com/sleepycat/je/Transaction.html" title="class in com.sleepycat.je">Transaction</a> txn,
|
||
|
|
<a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> config)</code>
|
||
|
|
<div class="block">Opens a cursor that returns the entities qualifying for the join.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i3" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">PK</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityJoin.html#keys--">keys</a></span>()</code>
|
||
|
|
<div class="block">Opens a cursor that returns the primary keys of entities qualifying for
|
||
|
|
the join.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i4" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">PK</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityJoin.html#keys-com.sleepycat.je.Transaction-com.sleepycat.je.CursorConfig-">keys</a></span>(<a href="../../../com/sleepycat/je/Transaction.html" title="class in com.sleepycat.je">Transaction</a> txn,
|
||
|
|
<a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> config)</code>
|
||
|
|
<div class="block">Opens a cursor that returns the primary keys of entities qualifying for
|
||
|
|
the join.</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="EntityJoin-com.sleepycat.persist.PrimaryIndex-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>EntityJoin</h4>
|
||
|
|
<pre>public EntityJoin(<a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">PK</a>,<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">E</a>> index)</pre>
|
||
|
|
<div class="block">Creates a join object for a given primary index.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>index</code> - the primary index on which the join will operate.</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="addCondition-com.sleepycat.persist.SecondaryIndex-java.lang.Object-">
|
||
|
|
<!-- -->
|
||
|
|
</a><a name="addCondition-com.sleepycat.persist.SecondaryIndex-SK-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>addCondition</h4>
|
||
|
|
<pre>public <SK> void addCondition(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist">SecondaryIndex</a><SK,<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">PK</a>,<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">E</a>> index,
|
||
|
|
SK key)</pre>
|
||
|
|
<div class="block">Adds a secondary key condition to the equality join. Only entities
|
||
|
|
having the given key value in the given secondary index will be returned
|
||
|
|
by the join operation.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
||
|
|
<dd><code>SK</code> - the secondary key class.</dd>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>index</code> - the secondary index containing the given key value.</dd>
|
||
|
|
<dd><code>key</code> - the key value to match during the join.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="entities--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>entities</h4>
|
||
|
|
<pre>public <a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">E</a>> entities()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Opens a cursor that returns the entities qualifying for the join. The
|
||
|
|
join operation is performed as the returned cursor is accessed.
|
||
|
|
|
||
|
|
<p>The operations performed with the cursor will not be transaction
|
||
|
|
protected, and <a href="../../../com/sleepycat/je/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the cursor.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if less than two conditions were added.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="entities-com.sleepycat.je.Transaction-com.sleepycat.je.CursorConfig-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>entities</h4>
|
||
|
|
<pre>public <a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">E</a>> entities(<a href="../../../com/sleepycat/je/Transaction.html" title="class in com.sleepycat.je">Transaction</a> txn,
|
||
|
|
<a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> config)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Opens a cursor that returns the entities qualifying for the join. The
|
||
|
|
join operation is performed as the returned cursor is accessed.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">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/je/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the cursor.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if less than two conditions were added.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">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/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">PK</a>> keys()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Opens a cursor that returns the primary keys of entities qualifying for
|
||
|
|
the join. The join operation is performed as the returned cursor is
|
||
|
|
accessed.
|
||
|
|
|
||
|
|
<p>The operations performed with the cursor will not be transaction
|
||
|
|
protected, and <a href="../../../com/sleepycat/je/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the cursor.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if less than two conditions were added.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="keys-com.sleepycat.je.Transaction-com.sleepycat.je.CursorConfig-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>keys</h4>
|
||
|
|
<pre>public <a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityJoin.html" title="type parameter in EntityJoin">PK</a>> keys(<a href="../../../com/sleepycat/je/Transaction.html" title="class in com.sleepycat.je">Transaction</a> txn,
|
||
|
|
<a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> config)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Opens a cursor that returns the primary keys of entities qualifying for
|
||
|
|
the join. The join operation is performed as the returned cursor is
|
||
|
|
accessed.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">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/je/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the cursor.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if less than two conditions were added.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">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>
|
||
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
|
<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/EntityJoin.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"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../com/sleepycat/persist/EntityResult.html" title="class in com.sleepycat.persist"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../index.html?com/sleepycat/persist/EntityJoin.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="EntityJoin.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) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
||
|
|
</body>
|
||
|
|
</html>
|