greg/stasis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
stasis/je-7.5.11/docs/java/com/sleepycat/je/DiskOrderedCursorConfig.html

699 lines
28 KiB
HTML
Raw Normal View History

initial import
2019-06-25 20:12:40 +00:00
<!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:45 EDT 2017 -->
<title>DiskOrderedCursorConfig (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="DiskOrderedCursorConfig (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":42,"i6":42,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":42,"i13":42,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/DiskOrderedCursorConfig.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/je/DiskOrderedCursor.html" title="class in com.sleepycat.je"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/sleepycat/je/DiskOrderedCursorProducerException.html" title="class in com.sleepycat.je"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/je/DiskOrderedCursorConfig.html" target="_top">Frames</a></li>
<li><a href="DiskOrderedCursorConfig.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.je</div>
<h2 title="Class DiskOrderedCursorConfig" class="title">Class DiskOrderedCursorConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.je.DiskOrderedCursorConfig</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DiskOrderedCursorConfig</span>
extends java.lang.Object
implements java.lang.Cloneable</pre>
<div class="block">Specifies the attributes of a DiskOrderedCursor.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#DEFAULT">DEFAULT</a></span></code>
<div class="block">Default configuration used if null is passed to methods that create a
cursor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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">&nbsp;</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/je/DiskOrderedCursorConfig.html#DiskOrderedCursorConfig--">DiskOrderedCursorConfig</a></span>()</code>
<div class="block">An instance created using the default constructor is initialized with
the system's default settings.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#clone--">clone</a></span>()</code>
<div class="block">Returns a copy of this configuration object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#getBINsOnly--">getBINsOnly</a></span>()</code>
<div class="block">Returns true if the DiskOrderedCursor is configured to scan BINs only,
returning all record keys and only those record data that are embedded
in the BINs.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#getInternalMemoryLimit--">getInternalMemoryLimit</a></span>()</code>
<div class="block">Returns the maximum amount of JE Cache Memory that the
DiskOrderedScan can use at one time.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#getKeysOnly--">getKeysOnly</a></span>()</code>
<div class="block">Returns true if the DiskOrderedCursor is configured to return only
keys.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#getLSNBatchSize--">getLSNBatchSize</a></span>()</code>
<div class="block">Returns the maximum number of LSNs to be sorted that this
DiskOrderedCursor is configured for.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#getMaxSeedMillisecs--">getMaxSeedMillisecs</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">this method returns zero and will be removed in a future
release.</span></div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#getMaxSeedNodes--">getMaxSeedNodes</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">this method returns zero and will be removed in a future
release.</span></div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#getQueueSize--">getQueueSize</a></span>()</code>
<div class="block">Returns the maximum number of entries in the queue before the
DiskOrderedCursor producer thread blocks.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#setBINsOnly-boolean-">setBINsOnly</a></span>(boolean&nbsp;binsOnly)</code>
<div class="block">Specify whether the DiskOrderedCursor should scan the BINs only.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#setInternalMemoryLimit-long-">setInternalMemoryLimit</a></span>(long&nbsp;internalMemoryLimit)</code>
<div class="block">Set the maximum amount of JE Cache Memory that the DiskOrderedScan
can use at one time.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#setKeysOnly-boolean-">setKeysOnly</a></span>(boolean&nbsp;keysOnly)</code>
<div class="block">Specify whether the DiskOrderedCursor should return only the key or key
+ data.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#setLSNBatchSize-long-">setLSNBatchSize</a></span>(long&nbsp;lsnBatchSize)</code>
<div class="block">Set the maximum number of LSNs to gather and sort at any one time.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#setMaxSeedMillisecs-long-">setMaxSeedMillisecs</a></span>(long&nbsp;maxSeedMillisecs)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">this method has no effect and will be removed in a future
release.</span></div>
</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#setMaxSeedNodes-long-">setMaxSeedNodes</a></span>(long&nbsp;maxSeedNodes)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">this method has no effect and will be removed in a future
release.</span></div>
</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#setQueueSize-int-">setQueueSize</a></span>(int&nbsp;queueSize)</code>
<div class="block">Set the queue size for entries being passed between the
DiskOrderedCursor producer thread and the application's consumer
thread.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html#toString--">toString</a></span>()</code>
<div class="block">Returns the values for each configuration attribute.</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&nbsp;java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static final&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a> DEFAULT</pre>
<div class="block">Default configuration used if null is passed to methods that create a
cursor.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DiskOrderedCursorConfig--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DiskOrderedCursorConfig</h4>
<pre>public&nbsp;DiskOrderedCursorConfig()</pre>
<div class="block">An instance created using the default constructor is initialized with
the system's default settings.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setKeysOnly-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKeysOnly</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a>&nbsp;setKeysOnly(boolean&nbsp;keysOnly)</pre>
<div class="block">Specify whether the DiskOrderedCursor should return only the key or key
+ data. The default value is false (key + data). If keyOnly is true,
the performance of the disk ordered scan will be better, because the
Cursor only descends to the BIN level.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keysOnly</code> - If true, return only keys from this cursor.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
</dl>
</li>
</ul>
<a name="getKeysOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeysOnly</h4>
<pre>public&nbsp;boolean&nbsp;getKeysOnly()</pre>
<div class="block">Returns true if the DiskOrderedCursor is configured to return only
keys. Returns false if it is configured to return keys + data.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the DiskOrderedCursor is configured to return keys only.</dd>
</dl>
</li>
</ul>
<a name="setBINsOnly-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBINsOnly</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a>&nbsp;setBINsOnly(boolean&nbsp;binsOnly)</pre>
<div class="block">Specify whether the DiskOrderedCursor should scan the BINs only. If
true, the performance of the disk ordered scan will be better, because
LNs are not read from disk. However, in this case, the data portion
of a record will be returned only if it is embedded in the BIN;
otherwise only the key will be returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>binsOnly</code> - If true, return keys and, if available, the associated
embedded data.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
</dl>
</li>
</ul>
<a name="getBINsOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBINsOnly</h4>
<pre>public&nbsp;boolean&nbsp;getBINsOnly()</pre>
<div class="block">Returns true if the DiskOrderedCursor is configured to scan BINs only,
returning all record keys and only those record data that are embedded
in the BINs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the DiskOrderedCursor is configured to scan BINs only.</dd>
</dl>
</li>
</ul>
<a name="setLSNBatchSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLSNBatchSize</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a>&nbsp;setLSNBatchSize(long&nbsp;lsnBatchSize)</pre>
<div class="block">Set the maximum number of LSNs to gather and sort at any one time. The
default is an unlimited number of LSNs. Setting this lower causes the
DiskOrderedScan to use less memory, but it sorts and processes LSNs more
frequently thereby causing slower performance. Setting this higher will
in general improve performance at the expense of memory. Each LSN uses
16 bytes of memory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lsnBatchSize</code> - the maximum number of LSNs to accumulate and sort
per batch.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
</dl>
</li>
</ul>
<a name="getLSNBatchSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLSNBatchSize</h4>
<pre>public&nbsp;long&nbsp;getLSNBatchSize()</pre>
<div class="block">Returns the maximum number of LSNs to be sorted that this
DiskOrderedCursor is configured for.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of LSNs to be sorted that this
DiskOrderedCursor is configured for.</dd>
</dl>
</li>
</ul>
<a name="setInternalMemoryLimit-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInternalMemoryLimit</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a>&nbsp;setInternalMemoryLimit(long&nbsp;internalMemoryLimit)</pre>
<div class="block">Set the maximum amount of JE Cache Memory that the DiskOrderedScan
can use at one time. The default is an unlimited amount of memory.
Setting this lower causes the DiskOrderedScan to use less memory, but it
sorts and processes LSNs more frequently thereby generally causing slower
performance. Setting this higher will in general improve performance at
the expense of JE cache memory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internalMemoryLimit</code> - the maximum number of non JE Cache bytes to
use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="EnvironmentStats.html#cacheUnexpectedSizes">Cache
Statistics: Unexpected Sizes</a></dd>
</dl>
</li>
</ul>
<a name="getInternalMemoryLimit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInternalMemoryLimit</h4>
<pre>public&nbsp;long&nbsp;getInternalMemoryLimit()</pre>
<div class="block">Returns the maximum amount of JE Cache Memory that the
DiskOrderedScan can use at one time.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum amount of non JE Cache Memory that preload can use at
one time.</dd>
</dl>
</li>
</ul>
<a name="setQueueSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueueSize</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a>&nbsp;setQueueSize(int&nbsp;queueSize)</pre>
<div class="block">Set the queue size for entries being passed between the
DiskOrderedCursor producer thread and the application's consumer
thread. If the queue size reaches this number of entries, the producer
thread will block until the application thread removes one or more
entries (by calling ForwardCursor.getNext(). The default is 1000.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queueSize</code> - the maximum number of entries the queue can hold before
the producer thread blocks.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this</dd>
</dl>
</li>
</ul>
<a name="getQueueSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueSize</h4>
<pre>public&nbsp;int&nbsp;getQueueSize()</pre>
<div class="block">Returns the maximum number of entries in the queue before the
DiskOrderedCursor producer thread blocks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of entries in the queue before the
DiskOrderedCursor producer thread blocks.</dd>
</dl>
</li>
</ul>
<a name="setMaxSeedMillisecs-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxSeedMillisecs</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a>&nbsp;setMaxSeedMillisecs(long&nbsp;maxSeedMillisecs)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">this method has no effect and will be removed in a future
release.</span></div>
</li>
</ul>
<a name="getMaxSeedMillisecs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxSeedMillisecs</h4>
<pre>public&nbsp;long&nbsp;getMaxSeedMillisecs()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">this method returns zero and will be removed in a future
release.</span></div>
</li>
</ul>
<a name="setMaxSeedNodes-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxSeedNodes</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a>&nbsp;setMaxSeedNodes(long&nbsp;maxSeedNodes)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">this method has no effect and will be removed in a future
release.</span></div>
</li>
</ul>
<a name="getMaxSeedNodes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxSeedNodes</h4>
<pre>public&nbsp;long&nbsp;getMaxSeedNodes()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">this method returns zero and will be removed in a future
release.</span></div>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/je/DiskOrderedCursorConfig.html" title="class in com.sleepycat.je">DiskOrderedCursorConfig</a>&nbsp;clone()</pre>
<div class="block">Returns a copy of this configuration object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Returns the values for each configuration attribute.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the values for each configuration attribute.</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/DiskOrderedCursorConfig.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/je/DiskOrderedCursor.html" title="class in com.sleepycat.je"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/sleepycat/je/DiskOrderedCursorProducerException.html" title="class in com.sleepycat.je"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/je/DiskOrderedCursorConfig.html" target="_top">Frames</a></li>
<li><a href="DiskOrderedCursorConfig.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
</body>
</html>
Reference in a new issue Copy permalink