| <!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>ScannerBase (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="ScannerBase (Apache Accumulo Project 1.9.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ScannerBase.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/Scanner.html" title="interface in org.apache.accumulo.core.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/accumulo/core/client/TableDeletedException.html" title="class in org.apache.accumulo.core.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/accumulo/core/client/ScannerBase.html" target="_top">Frames</a></li> |
| <li><a href="ScannerBase.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.accumulo.core.client</div> |
| <h2 title="Interface ScannerBase" class="title">Interface ScannerBase</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</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><<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><<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>>></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client">BatchDeleter</a>, <a href="../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client">BatchScanner</a>, <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client">ClientSideIteratorScanner</a>, <a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html" title="class in org.apache.accumulo.core.client">IsolatedScanner</a>, <a href="../../../../../org/apache/accumulo/core/client/mock/MockBatchDeleter.html" title="class in org.apache.accumulo.core.client.mock">MockBatchDeleter</a>, <a href="../../../../../org/apache/accumulo/core/client/mock/MockBatchScanner.html" title="class in org.apache.accumulo.core.client.mock">MockBatchScanner</a>, <a href="../../../../../org/apache/accumulo/core/client/mock/MockScanner.html" title="class in org.apache.accumulo.core.client.mock">MockScanner</a>, <a href="../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html" title="class in org.apache.accumulo.core.client.mock">MockScannerBase</a>, org.apache.accumulo.core.client.impl.ScannerOptions</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ScannerBase</span> |
| extends <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><<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><<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>>>, <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></pre> |
| <div class="block">This class hosts configuration methods that are shared between different types of scanners.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator-org.apache.accumulo.core.client.IteratorSetting-">addScanIterator</a></span>(<a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a> cfg)</code> |
| <div class="block">Add a server-side scan iterator.</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/ScannerBase.html#clearClassLoaderContext--">clearClassLoaderContext</a></span>()</code> |
| <div class="block">Clears the current classloader context set on this scanner</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearColumns--">clearColumns</a></span>()</code> |
| <div class="block">Clears the columns to be fetched (useful for resetting the scanner for reuse).</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearSamplerConfiguration--">clearSamplerConfiguration</a></span>()</code> |
| <div class="block">Clears sampler configuration making a scanner read all data.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearScanIterators--">clearScanIterators</a></span>()</code> |
| <div class="block">Clears scan iterators prior to returning a scanner to the pool.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#close--">close</a></span>()</code> |
| <div class="block">Closes any underlying connections on the scanner.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn-org.apache.accumulo.core.client.IteratorSetting.Column-">fetchColumn</a></span>(<a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client">IteratorSetting.Column</a> column)</code> |
| <div class="block">Adds a column to the list of columns that will be fetch by this scanner.</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/ScannerBase.html#fetchColumn-org.apache.hadoop.io.Text-org.apache.hadoop.io.Text-">fetchColumn</a></span>(org.apache.hadoop.io.Text colFam, |
| org.apache.hadoop.io.Text colQual)</code> |
| <div class="block">Adds a column to the list of columns that will be fetched by this scanner.</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/ScannerBase.html#fetchColumnFamily-org.apache.hadoop.io.Text-">fetchColumnFamily</a></span>(org.apache.hadoop.io.Text col)</code> |
| <div class="block">Adds a column family to the list of columns that will be fetched by this scanner.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getAuthorizations--">getAuthorizations</a></span>()</code> |
| <div class="block">Returns the authorizations that have been set on the scanner</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getBatchTimeout-java.util.concurrent.TimeUnit-">getBatchTimeout</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> |
| <div class="block">Returns the timeout to fill a batch in the given TimeUnit.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getClassLoaderContext--">getClassLoaderContext</a></span>()</code> |
| <div class="block">Returns the name of the current classloader context set on this scanner</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getSamplerConfiguration--">getSamplerConfiguration</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getTimeout-java.util.concurrent.TimeUnit-">getTimeout</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> |
| <div class="block">Returns the setting for how long a scanner will automatically retry when a failure occurs.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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><<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><<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>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator--">iterator</a></span>()</code> |
| <div class="block">Returns an iterator over an accumulo table.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#removeScanIterator-java.lang.String-">removeScanIterator</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> iteratorName)</code> |
| <div class="block">Remove an iterator from the list of iterators.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setBatchTimeout-long-java.util.concurrent.TimeUnit-">setBatchTimeout</a></span>(long timeOut, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> |
| <div class="block">This setting determines how long a scanner will wait to fill the returned batch.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setClassLoaderContext-java.lang.String-">setClassLoaderContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classLoaderContext)</code> |
| <div class="block">Sets the name of the classloader context on this scanner.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setSamplerConfiguration-org.apache.accumulo.core.client.sample.SamplerConfiguration-">setSamplerConfiguration</a></span>(<a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a> samplerConfig)</code> |
| <div class="block">Setting this will cause the scanner to read sample data, as long as that sample data was |
| generated with the given configuration.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setTimeout-long-java.util.concurrent.TimeUnit-">setTimeout</a></span>(long timeOut, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code> |
| <div class="block">This setting determines how long a scanner will automatically retry when a failure occurs.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#updateScanIteratorOption-java.lang.String-java.lang.String-java.lang.String-">updateScanIteratorOption</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> iteratorName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> |
| <div class="block">Update the options for an iterator.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface 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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addScanIterator-org.apache.accumulo.core.client.IteratorSetting-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addScanIterator</h4> |
| <pre>void addScanIterator(<a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a> cfg)</pre> |
| <div class="block">Add a server-side scan iterator.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cfg</code> - fully specified scan-time iterator, including all options for the iterator. Any |
| changes to the iterator setting after this call are not propagated to the stored |
| iterator.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the setting conflicts with existing iterators</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeScanIterator-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeScanIterator</h4> |
| <pre>void removeScanIterator(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> iteratorName)</pre> |
| <div class="block">Remove an iterator from the list of iterators.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>iteratorName</code> - nickname used for the iterator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateScanIteratorOption-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateScanIteratorOption</h4> |
| <pre>void updateScanIteratorOption(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> iteratorName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre> |
| <div class="block">Update the options for an iterator. Note that this does <b>not</b> change the iterator options |
| during a scan, it just replaces the given option on a configured iterator before a scan is |
| started.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>iteratorName</code> - the name of the iterator to change</dd> |
| <dd><code>key</code> - the name of the option</dd> |
| <dd><code>value</code> - the new value for the named option</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fetchColumnFamily-org.apache.hadoop.io.Text-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchColumnFamily</h4> |
| <pre>void fetchColumnFamily(org.apache.hadoop.io.Text col)</pre> |
| <div class="block">Adds a column family to the list of columns that will be fetched by this scanner. By default |
| when no columns have been added the scanner fetches all columns. To fetch multiple column |
| families call this function multiple times. |
| |
| <p> |
| This can help limit which locality groups are read on the server side. |
| |
| <p> |
| When used in conjunction with custom iterators, the set of column families fetched is passed to |
| the top iterator's seek method. Custom iterators may change this set of column families when |
| calling seek on their source.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>col</code> - the column family to be fetched</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fetchColumn-org.apache.hadoop.io.Text-org.apache.hadoop.io.Text-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchColumn</h4> |
| <pre>void fetchColumn(org.apache.hadoop.io.Text colFam, |
| org.apache.hadoop.io.Text colQual)</pre> |
| <div class="block">Adds a column to the list of columns that will be fetched by this scanner. The column is |
| identified by family and qualifier. By default when no columns have been added the scanner |
| fetches all columns. |
| |
| <p> |
| <b>WARNING</b>. Using this method with custom iterators may have unexpected results. Iterators |
| have control over which column families are fetched. However iterators have no control over |
| which column qualifiers are fetched. When this method is called it activates a system iterator |
| that only allows the requested family/qualifier pairs through. This low level filtering |
| prevents custom iterators from requesting additional column families when calling seek. |
| |
| <p> |
| For an example, assume fetchColumns(A, Q1) and fetchColumns(B,Q1) is called on a scanner and a |
| custom iterator is configured. The families (A,B) will be passed to the seek method of the |
| custom iterator. If the custom iterator seeks its source iterator using the families (A,B,C), |
| it will never see any data from C because the system iterator filtering A:Q1 and B:Q1 will |
| prevent the C family from getting through. ACCUMULO-3905 also has an example of the type of |
| problem this method can cause. |
| |
| <p> |
| tl;dr If using a custom iterator with a seek method that adds column families, then may want to |
| avoid using this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>colFam</code> - the column family of the column to be fetched</dd> |
| <dd><code>colQual</code> - the column qualifier of the column to be fetched</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fetchColumn-org.apache.accumulo.core.client.IteratorSetting.Column-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchColumn</h4> |
| <pre>void fetchColumn(<a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client">IteratorSetting.Column</a> column)</pre> |
| <div class="block">Adds a column to the list of columns that will be fetch by this scanner.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>column</code> - the <a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client"><code>IteratorSetting.Column</code></a> to fetch</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearColumns--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearColumns</h4> |
| <pre>void clearColumns()</pre> |
| <div class="block">Clears the columns to be fetched (useful for resetting the scanner for reuse). Once cleared, |
| the scanner will fetch all columns.</div> |
| </li> |
| </ul> |
| <a name="clearScanIterators--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearScanIterators</h4> |
| <pre>void clearScanIterators()</pre> |
| <div class="block">Clears scan iterators prior to returning a scanner to the pool.</div> |
| </li> |
| </ul> |
| <a name="iterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre><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><<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><<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>>> iterator()</pre> |
| <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> in interface <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><<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><<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>>></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-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimeout</h4> |
| <pre>void setTimeout(long timeOut, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> |
| <div class="block">This setting determines how long a scanner will automatically retry when a failure occurs. By |
| default, a scanner will retry forever. |
| |
| <p> |
| Setting the timeout to zero (with any time unit) or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> (with |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true#MILLISECONDS" title="class or interface in java.util.concurrent"><code>TimeUnit.MILLISECONDS</code></a>) means no timeout.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeOut</code> - the length of the timeout</dd> |
| <dd><code>timeUnit</code> - the units of the timeout</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTimeout-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeout</h4> |
| <pre>long getTimeout(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> |
| <div class="block">Returns the setting for how long a scanner will automatically retry when a failure occurs.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timeout configured for this scanner</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Closes any underlying connections on the scanner. This may invalidate any iterators derived |
| from the Scanner, causing them to throw exceptions.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><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></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAuthorizations--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthorizations</h4> |
| <pre><a href="../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> getAuthorizations()</pre> |
| <div class="block">Returns the authorizations that have been set on the scanner</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The authorizations set on the scanner instance</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSamplerConfiguration-org.apache.accumulo.core.client.sample.SamplerConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSamplerConfiguration</h4> |
| <pre>void setSamplerConfiguration(<a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a> samplerConfig)</pre> |
| <div class="block">Setting this will cause the scanner to read sample data, as long as that sample data was |
| generated with the given configuration. By default this is not set and all data is read. |
| |
| <p> |
| One way to use this method is as follows, where the sampler configuration is obtained from the |
| table configuration. Sample data can be generated in many different ways, so its important to |
| verify the sample data configuration meets expectations. |
| |
| <pre> |
| <code> |
| // could cache this if creating many scanners to avoid RPCs. |
| SamplerConfiguration samplerConfig = |
| connector.tableOperations().getSamplerConfiguration(table); |
| // verify table's sample data is generated in an expected way before using |
| userCode.verifySamplerConfig(samplerConfig); |
| scanner.setSamplerCongiguration(samplerConfig); |
| </code> |
| </pre> |
| |
| <p> |
| Of course this is not the only way to obtain a <a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample"><code>SamplerConfiguration</code></a>, it could be a |
| constant, configuration, etc. |
| |
| <p> |
| If sample data is not present or sample data was generated with a different configuration, then |
| the scanner iterator will throw a <a href="../../../../../org/apache/accumulo/core/client/SampleNotPresentException.html" title="class in org.apache.accumulo.core.client"><code>SampleNotPresentException</code></a>. Also if a table's sampler |
| configuration is changed while a scanner is iterating over a table, a |
| <a href="../../../../../org/apache/accumulo/core/client/SampleNotPresentException.html" title="class in org.apache.accumulo.core.client"><code>SampleNotPresentException</code></a> may be thrown.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSamplerConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSamplerConfiguration</h4> |
| <pre><a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a> getSamplerConfiguration()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>currently set sampler configuration. Returns null if no sampler configuration is set.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearSamplerConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearSamplerConfiguration</h4> |
| <pre>void clearSamplerConfiguration()</pre> |
| <div class="block">Clears sampler configuration making a scanner read all data. After calling this, |
| <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getSamplerConfiguration--"><code>getSamplerConfiguration()</code></a> should return null.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBatchTimeout-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBatchTimeout</h4> |
| <pre>void setBatchTimeout(long timeOut, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> |
| <div class="block">This setting determines how long a scanner will wait to fill the returned batch. By default, a |
| scanner wait until the batch is full. |
| |
| <p> |
| Setting the timeout to zero (with any time unit) or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> (with |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true#MILLISECONDS" title="class or interface in java.util.concurrent"><code>TimeUnit.MILLISECONDS</code></a>) means no timeout.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeOut</code> - the length of the timeout</dd> |
| <dd><code>timeUnit</code> - the units of the timeout</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBatchTimeout-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBatchTimeout</h4> |
| <pre>long getBatchTimeout(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre> |
| <div class="block">Returns the timeout to fill a batch in the given TimeUnit.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the batch timeout configured for this scanner</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setClassLoaderContext-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClassLoaderContext</h4> |
| <pre>void setClassLoaderContext(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classLoaderContext)</pre> |
| <div class="block">Sets the name of the classloader context on this scanner. See the administration chapter of the |
| user manual for details on how to configure and use classloader contexts.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classLoaderContext</code> - name of the classloader context</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if context is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearClassLoaderContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearClassLoaderContext</h4> |
| <pre>void clearClassLoaderContext()</pre> |
| <div class="block">Clears the current classloader context set on this scanner</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClassLoaderContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getClassLoaderContext</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getClassLoaderContext()</pre> |
| <div class="block">Returns the name of the current classloader context set on this scanner</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>name of the current context</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.8.0</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/ScannerBase.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/Scanner.html" title="interface in org.apache.accumulo.core.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/accumulo/core/client/TableDeletedException.html" title="class in org.apache.accumulo.core.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/accumulo/core/client/ScannerBase.html" target="_top">Frames</a></li> |
| <li><a href="ScannerBase.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2011–2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
