Google Git
Sign in
apache / accumulo-website / 949d7010a2c1ab8ef4c0e3bed1e6a2938a58f06c / . / 1.9 / apidocs / org / apache / accumulo / core / client / IsolatedScanner.html
blob: f40aebb2029668353db7bf5f130b0184caa68226 [file] [log] [blame]
<!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_201) on Thu Apr 11 20:05:14 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IsolatedScanner (Apache Accumulo Project 1.9.3 API)</title>
<meta name="date" content="2019-04-11">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.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="IsolatedScanner (Apache Accumulo Project 1.9.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":42,"i6":10,"i7":10,"i8":10,"i9":10,"i10":42};
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/IsolatedScanner.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.MemoryRowBuffer.html" title="class in org.apache.accumulo.core.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/accumulo/core/client/IsolatedScanner.html" target="_top">Frames</a></li>
<li><a href="IsolatedScanner.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.accumulo.core.client.impl.ScannerOptions">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>Field&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">org.apache.accumulo.core.client</div>
<h2 title="Class IsolatedScanner" class="title">Class IsolatedScanner</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.accumulo.core.client.impl.ScannerOptions</li>
<li>
<ul class="inheritance">
<li>org.apache.accumulo.core.client.IsolatedScanner</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a>&lt;<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>&gt;&gt;, <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">IsolatedScanner</span>
extends org.apache.accumulo.core.client.impl.ScannerOptions
implements <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></pre>
<div class="block">A scanner that presents a row isolated view of an accumulo table. Rows are buffered in memory on
the client side. If you think your rows may not fit into memory, then you can provide an
alternative row buffer factory to the constructor. This would allow rows to be buffered to disk
for example.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.MemoryRowBuffer.html" title="class in org.apache.accumulo.core.client">IsolatedScanner.MemoryRowBuffer</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.MemoryRowBufferFactory.html" title="class in org.apache.accumulo.core.client">IsolatedScanner.MemoryRowBufferFactory</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.RowBuffer.html" title="interface in org.apache.accumulo.core.client">IsolatedScanner.RowBuffer</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.RowBufferFactory.html" title="interface in org.apache.accumulo.core.client">IsolatedScanner.RowBufferFactory</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.accumulo.core.client.impl.ScannerOptions">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.accumulo.core.client.impl.ScannerOptions</h3>
<code>batchTimeOut, classLoaderContext, fetchedColumns, serverSideIteratorList, serverSideIteratorOptions, timeOut</code></li>
</ul>
</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="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#IsolatedScanner-org.apache.accumulo.core.client.Scanner-">IsolatedScanner</a></span>(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a>&nbsp;scanner)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#IsolatedScanner-org.apache.accumulo.core.client.Scanner-org.apache.accumulo.core.client.IsolatedScanner.RowBufferFactory-">IsolatedScanner</a></span>(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a>&nbsp;scanner,
<a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.RowBufferFactory.html" title="interface in org.apache.accumulo.core.client">IsolatedScanner.RowBufferFactory</a>&nbsp;bufferFactory)</code>&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#disableIsolation--">disableIsolation</a></span>()</code>
<div class="block">Disables row isolation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#enableIsolation--">enableIsolation</a></span>()</code>
<div class="block">Enables row isolation.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#getBatchSize--">getBatchSize</a></span>()</code>
<div class="block">Returns the batch size (number of Key/Value pairs) that will be fetched at a time from a tablet
server.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#getRange--">getRange</a></span>()</code>
<div class="block">Returns the range of keys to scan over.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#getReadaheadThreshold--">getReadaheadThreshold</a></span>()</code>
<div class="block">The number of batches of Key/Value pairs returned before the <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> will begin to
prefetch the next batch</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#getTimeOut--">getTimeOut</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a>&lt;<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#iterator--">iterator</a></span>()</code>
<div class="block">Returns an iterator over an accumulo table.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#setBatchSize-int-">setBatchSize</a></span>(int&nbsp;size)</code>
<div class="block">Sets the number of Key/Value pairs that will be fetched at a time from a tablet server.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#setRange-org.apache.accumulo.core.data.Range-">setRange</a></span>(<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>&nbsp;range)</code>
<div class="block">Sets the range of keys to scan over.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#setReadaheadThreshold-long-">setReadaheadThreshold</a></span>(long&nbsp;batches)</code>
<div class="block">Sets the number of batches of Key/Value pairs returned before the <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> will begin to
prefetch the next batch</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html#setTimeOut-int-">setTimeOut</a></span>(int&nbsp;timeOut)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.accumulo.core.client.impl.ScannerOptions">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.accumulo.core.client.impl.ScannerOptions</h3>
<code>addScanIterator, clearClassLoaderContext, clearColumns, clearSamplerConfiguration, clearScanIterators, close, fetchColumn, fetchColumn, fetchColumnFamily, getAuthorizations, getBatchTimeout, getClassLoaderContext, getFetchedColumns, getSamplerConfiguration, getTimeout, removeScanIterator, setBatchTimeout, setClassLoaderContext, setOptions, setSamplerConfiguration, setTimeout, updateScanIteratorOption</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.accumulo.core.client.ScannerBase">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.accumulo.core.client.<a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></h3>
<code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator-org.apache.accumulo.core.client.IteratorSetting-">addScanIterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearClassLoaderContext--">clearClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearColumns--">clearColumns</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearSamplerConfiguration--">clearSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearScanIterators--">clearScanIterators</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#close--">close</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn-org.apache.accumulo.core.client.IteratorSetting.Column-">fetchColumn</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn-org.apache.hadoop.io.Text-org.apache.hadoop.io.Text-">fetchColumn</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumnFamily-org.apache.hadoop.io.Text-">fetchColumnFamily</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getAuthorizations--">getAuthorizations</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getBatchTimeout-java.util.concurrent.TimeUnit-">getBatchTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getClassLoaderContext--">getClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getSamplerConfiguration--">getSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getTimeout-java.util.concurrent.TimeUnit-">getTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#removeScanIterator-java.lang.String-">removeScanIterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setBatchTimeout-long-java.util.concurrent.TimeUnit-">setBatchTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setClassLoaderContext-java.lang.String-">setClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setSamplerConfiguration-org.apache.accumulo.core.client.sample.SamplerConfiguration-">setSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setTimeout-long-java.util.concurrent.TimeUnit-">setTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#updateScanIteratorOption-java.lang.String-java.lang.String-java.lang.String-">updateScanIteratorOption</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></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="IsolatedScanner-org.apache.accumulo.core.client.Scanner-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IsolatedScanner</h4>
<pre>public&nbsp;IsolatedScanner(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a>&nbsp;scanner)</pre>
</li>
</ul>
<a name="IsolatedScanner-org.apache.accumulo.core.client.Scanner-org.apache.accumulo.core.client.IsolatedScanner.RowBufferFactory-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IsolatedScanner</h4>
<pre>public&nbsp;IsolatedScanner(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a>&nbsp;scanner,
<a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.RowBufferFactory.html" title="interface in org.apache.accumulo.core.client">IsolatedScanner.RowBufferFactory</a>&nbsp;bufferFactory)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="iterator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a>&lt;<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>&gt;&gt;&nbsp;iterator()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator--">ScannerBase</a></code></span></div>
<div class="block">Returns an iterator over an accumulo table. This iterator uses the options that are currently
set for its lifetime, so setting options will have no effect on existing iterators.
<p>
Keys returned by the iterator are not guaranteed to be in sorted order.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a>&lt;<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>&gt;&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator--">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>iterator</code>&nbsp;in class&nbsp;<code>org.apache.accumulo.core.client.impl.ScannerOptions</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator over Key,Value pairs which meet the restrictions set on the scanner</dd>
</dl>
</li>
</ul>
<a name="setTimeOut-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeOut</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;void&nbsp;setTimeOut(int&nbsp;timeOut)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setTimeOut-int-">Scanner</a></code></span></div>
<div class="block">This setting determines how long a scanner will automatically retry when a failure occurs. By
default a scanner will retry forever.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setTimeOut-int-">setTimeOut</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeOut</code> - in seconds</dd>
</dl>
</li>
</ul>
<a name="getTimeOut--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimeOut</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;int&nbsp;getTimeOut()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getTimeOut--">Scanner</a></code></span></div>
<div class="block">Returns the setting for how long a scanner will automatically retry when a failure occurs.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getTimeOut--">getTimeOut</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timeout configured for this scanner</dd>
</dl>
</li>
</ul>
<a name="setRange-org.apache.accumulo.core.data.Range-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRange</h4>
<pre>public&nbsp;void&nbsp;setRange(<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>&nbsp;range)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setRange-org.apache.accumulo.core.data.Range-">Scanner</a></code></span></div>
<div class="block">Sets the range of keys to scan over.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setRange-org.apache.accumulo.core.data.Range-">setRange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>range</code> - key range to begin and end scan</dd>
</dl>
</li>
</ul>
<a name="getRange--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRange</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>&nbsp;getRange()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getRange--">Scanner</a></code></span></div>
<div class="block">Returns the range of keys to scan over.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getRange--">getRange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the range configured for this scanner</dd>
</dl>
</li>
</ul>
<a name="setBatchSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBatchSize</h4>
<pre>public&nbsp;void&nbsp;setBatchSize(int&nbsp;size)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setBatchSize-int-">Scanner</a></code></span></div>
<div class="block">Sets the number of Key/Value pairs that will be fetched at a time from a tablet server.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setBatchSize-int-">setBatchSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the number of Key/Value pairs to fetch per call to Accumulo</dd>
</dl>
</li>
</ul>
<a name="getBatchSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBatchSize</h4>
<pre>public&nbsp;int&nbsp;getBatchSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getBatchSize--">Scanner</a></code></span></div>
<div class="block">Returns the batch size (number of Key/Value pairs) that will be fetched at a time from a tablet
server.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getBatchSize--">getBatchSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the batch size configured for this scanner</dd>
</dl>
</li>
</ul>
<a name="enableIsolation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableIsolation</h4>
<pre>public&nbsp;void&nbsp;enableIsolation()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#enableIsolation--">Scanner</a></code></span></div>
<div class="block">Enables row isolation. Writes that occur to a row after a scan of that row has begun will not
be seen if this option is enabled.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#enableIsolation--">enableIsolation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
</dl>
</li>
</ul>
<a name="disableIsolation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableIsolation</h4>
<pre>public&nbsp;void&nbsp;disableIsolation()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#disableIsolation--">Scanner</a></code></span></div>
<div class="block">Disables row isolation. Writes that occur to a row after a scan of that row has begun may be
seen if this option is enabled.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#disableIsolation--">disableIsolation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
</dl>
</li>
</ul>
<a name="getReadaheadThreshold--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadaheadThreshold</h4>
<pre>public&nbsp;long&nbsp;getReadaheadThreshold()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getReadaheadThreshold--">Scanner</a></code></span></div>
<div class="block">The number of batches of Key/Value pairs returned before the <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> will begin to
prefetch the next batch</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getReadaheadThreshold--">getReadaheadThreshold</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of batches before read-ahead begins</dd>
</dl>
</li>
</ul>
<a name="setReadaheadThreshold-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setReadaheadThreshold</h4>
<pre>public&nbsp;void&nbsp;setReadaheadThreshold(long&nbsp;batches)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setReadaheadThreshold-long-">Scanner</a></code></span></div>
<div class="block">Sets the number of batches of Key/Value pairs returned before the <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> will begin to
prefetch the next batch</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setReadaheadThreshold-long-">setReadaheadThreshold</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>batches</code> - Non-negative number of batches</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/IsolatedScanner.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.MemoryRowBuffer.html" title="class in org.apache.accumulo.core.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/accumulo/core/client/IsolatedScanner.html" target="_top">Frames</a></li>
<li><a href="IsolatedScanner.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.accumulo.core.client.impl.ScannerOptions">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>Field&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>Copyright &#169; 2011&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>