http://git-wip-us.apache.org/repos/asf/accumulo/blob/823e2294/1.4/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html b/1.4/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html new file mode 100644 index 0000000..8b8170e --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html @@ -0,0 +1,479 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_95) on Thu Mar 03 19:53:22 EST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ClientSideIteratorScanner.ScannerTranslator (accumulo 1.4.5 API)</title> +<meta name="date" content="2016-03-03"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ClientSideIteratorScanner.ScannerTranslator (accumulo 1.4.5 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ClientSideIteratorScanner.ScannerTranslator.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/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html" target="_top">Frames</a></li> +<li><a href="ClientSideIteratorScanner.ScannerTranslator.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client</div> +<h2 title="Class ClientSideIteratorScanner.ScannerTranslator" class="title">Class ClientSideIteratorScanner.ScannerTranslator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/6/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.ClientSideIteratorScanner.ScannerTranslator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client">ClientSideIteratorScanner</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ClientSideIteratorScanner.ScannerTranslator</span> +extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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>></pre> +<div class="block">A class that wraps a Scanner in a SortedKeyValueIterator so that other accumulo iterators can use it as a source.</div> +</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </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>protected <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#scanner">scanner</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#ClientSideIteratorScanner.ScannerTranslator(org.apache.accumulo.core.client.Scanner)">ClientSideIteratorScanner.ScannerTranslator</a></strong>(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</code> +<div class="block">Constructs an accumulo iterator from a scanner.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment)">deepCopy</a></strong>(org.apache.accumulo.core.iterators.IteratorEnvironment env)</code> +<div class="block">Creates a deep copy of this iterator as though seek had not yet been called.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#getTopKey()">getTopKey</a></strong>()</code> +<div class="block">Returns top key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#getTopValue()">getTopValue</a></strong>()</code> +<div class="block">Returns top value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#hasTop()">hasTop</a></strong>()</code> +<div class="block">Returns true if the iterator has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#init(org.apache.accumulo.core.iterators.SortedKeyValueIterator,%20java.util.Map,%20org.apache.accumulo.core.iterators.IteratorEnvironment)">init</a></strong>(org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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>> source, + <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> options, + org.apache.accumulo.core.iterators.IteratorEnvironment env)</code> +<div class="block">Initializes the iterator.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#next()">next</a></strong>()</code> +<div class="block">Advances to the next K,V pair.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html#seek(org.apache.accumulo.core.data.Range,%20java.util.Collection,%20boolean)">seek</a></strong>(<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> range, + <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/accumulo/core/data/ByteSequence.html" title="class in org.apache.accumulo.core.data">ByteSequence</a>> columnFamilies, + boolean inclusive)</code> +<div class="block">Seeks to the first key in the Range, restricting the resulting K,V pairs to those with the specified columns.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="scanner"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>scanner</h4> +<pre>protected <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ClientSideIteratorScanner.ScannerTranslator(org.apache.accumulo.core.client.Scanner)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ClientSideIteratorScanner.ScannerTranslator</h4> +<pre>public ClientSideIteratorScanner.ScannerTranslator(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</pre> +<div class="block">Constructs an accumulo iterator from a scanner.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanner</code> - the scanner to iterate over</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="init(org.apache.accumulo.core.iterators.SortedKeyValueIterator, java.util.Map, org.apache.accumulo.core.iterators.IteratorEnvironment)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>public void init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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>> source, + <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> options, + org.apache.accumulo.core.iterators.IteratorEnvironment env) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><strong>Description copied from interface: <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator</code></strong></div> +<div class="block">Initializes the iterator. Data should not be read from the source in this method.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>init</code> in interface <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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="strong">Parameters:</span></dt><dd><code>source</code> - <tt>SortedKeyValueIterator</tt> source to read data from.</dd><dd><code>options</code> - <tt>Map</tt> map of string option names to option values.</dd><dd><code>env</code> - <tt>IteratorEnvironment</tt> environment in which iterator is being run.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - unused.</dd></dl> +</li> +</ul> +<a name="hasTop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasTop</h4> +<pre>public boolean hasTop()</pre> +<div class="block"><strong>Description copied from interface: <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator</code></strong></div> +<div class="block">Returns true if the iterator has more elements.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>hasTop</code> in interface <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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="strong">Returns:</span></dt><dd><tt>true</tt> if the iterator has more elements.</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public void next() + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><strong>Description copied from interface: <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator</code></strong></div> +<div class="block">Advances to the next K,V pair. Note that in minor compaction scope and in non-full major compaction scopes the iterator may see deletion entries. These + entries should be preserved by all iterators except ones that are strictly scan-time iterators that will never be configured for the minc or majc scopes. + Deletion entries are only removed during full major compactions.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>next</code> in interface <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if an I/O error occurs.</dd></dl> +</li> +</ul> +<a name="seek(org.apache.accumulo.core.data.Range, java.util.Collection, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>seek</h4> +<pre>public void seek(<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> range, + <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/accumulo/core/data/ByteSequence.html" title="class in org.apache.accumulo.core.data">ByteSequence</a>> columnFamilies, + boolean inclusive) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><strong>Description copied from interface: <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator</code></strong></div> +<div class="block">Seeks to the first key in the Range, restricting the resulting K,V pairs to those with the specified columns. An iterator does not have to stop at the end + of the range. The whole range is provided so that iterators can make optimizations. + + Seek may be called multiple times with different parameters after <code>SortedKeyValueIterator.init(org.apache.accumulo.core.iterators.SortedKeyValueIterator<K, V>, java.util.Map<java.lang.String, java.lang.String>, org.apache.accumulo.core.iterators.IteratorEnvironment)</code> is called. + + Iterators that examine groups of adjacent key/value pairs (e.g. rows) to determine their top key and value should be sure that they properly handle a seek + to a key in the middle of such a group (e.g. the middle of a row). Even if the client always seeks to a range containing an entire group (a,c), the tablet + server could send back a batch of entries corresponding to (a,b], then reseek the iterator to range (b,c) when the scan is continued. + + <code>columnFamilies</code> is used, at the lowest level, to determine which data blocks inside of an RFile need to be opened for this iterator. This set of data + blocks is also the set of locality groups defined for the given table. If no columnFamilies are provided, the data blocks for all locality groups inside of + the correct RFile will be opened and seeked in an attempt to find the correct start key, regardless of the startKey in the <code>range</code>. + + In an Accumulo instance in which multiple locality groups exist for a table, it is important to ensure that <code>columnFamilies</code> is properly set to the + minimum required column families to ensure that data from separate locality groups is not inadvertently read.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>seek</code> in interface <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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="strong">Parameters:</span></dt><dd><code>range</code> - <tt>Range</tt> of keys to iterate over.</dd><dd><code>columnFamilies</code> - <tt>Collection</tt> of column families to include or exclude.</dd><dd><code>inclusive</code> - <tt>boolean</tt> that indicates whether to include (true) or exclude (false) column families.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if an I/O error occurs.</dd></dl> +</li> +</ul> +<a name="getTopKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTopKey</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a> getTopKey()</pre> +<div class="block"><strong>Description copied from interface: <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator</code></strong></div> +<div class="block">Returns top key. Can be called 0 or more times without affecting behavior of next() or hasTop(). Note that in minor compaction scope and in non-full major + compaction scopes the iterator may see deletion entries. These entries should be preserved by all iterators except ones that are strictly scan-time + iterators that will never be configured for the minc or majc scopes. Deletion entries are only removed during full major compactions.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getTopKey</code> in interface <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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="strong">Returns:</span></dt><dd><tt>K</tt></dd></dl> +</li> +</ul> +<a name="getTopValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTopValue</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a> getTopValue()</pre> +<div class="block"><strong>Description copied from interface: <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator</code></strong></div> +<div class="block">Returns top value. Can be called 0 or more times without affecting behavior of next() or hasTop().</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getTopValue</code> in interface <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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="strong">Returns:</span></dt><dd><tt>V</tt></dd></dl> +</li> +</ul> +<a name="deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>deepCopy</h4> +<pre>public org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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>> deepCopy(org.apache.accumulo.core.iterators.IteratorEnvironment env)</pre> +<div class="block"><strong>Description copied from interface: <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator</code></strong></div> +<div class="block">Creates a deep copy of this iterator as though seek had not yet been called. init should be called on an iterator before deepCopy is called. init should + not need to be called on the copy that is returned by deepCopy; that is, when necessary init should be called in the deepCopy method on the iterator it + returns. The behavior is unspecified if init is called after deepCopy either on the original or the copy.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>deepCopy</code> in interface <code>org.apache.accumulo.core.iterators.SortedKeyValueIterator<<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="strong">Parameters:</span></dt><dd><code>env</code> - <tt>IteratorEnvironment</tt> environment in which iterator is being run.</dd> +<dt><span class="strong">Returns:</span></dt><dd><tt>SortedKeyValueIterator</tt> a copy of this iterator (with the same source and settings).</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ClientSideIteratorScanner.ScannerTranslator.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/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html" target="_top">Frames</a></li> +<li><a href="ClientSideIteratorScanner.ScannerTranslator.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/823e2294/1.4/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.html b/1.4/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.html new file mode 100644 index 0000000..e5756c4 --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.html @@ -0,0 +1,530 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_95) on Thu Mar 03 19:53:22 EST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ClientSideIteratorScanner (accumulo 1.4.5 API)</title> +<meta name="date" content="2016-03-03"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ClientSideIteratorScanner (accumulo 1.4.5 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ClientSideIteratorScanner.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/BatchWriter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ClientSideIteratorScanner.html" target="_top">Frames</a></li> +<li><a href="ClientSideIteratorScanner.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><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_org.apache.accumulo.core.client.impl.ScannerOptions">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client</div> +<h2 title="Class ClientSideIteratorScanner" class="title">Class ClientSideIteratorScanner</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/6/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.ClientSideIteratorScanner</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://docs.oracle.com/javase/6/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="../../../../../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="strong">ClientSideIteratorScanner</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 instantiates iterators on the client side instead of on the tablet server. This can be useful for testing iterators or in cases where you + don't want iterators affecting the performance of tablet servers.<br> + <br> + Suggested usage:<br> + <code>Scanner scanner = new ClientSideIteratorScanner(connector.createScanner(tableName, authorizations));</code><br> + <br> + Iterators added to this scanner will be run in the client JVM. Separate scan iterators can be run on the server side and client side by adding iterators to + the source scanner (which will execute server side) and to the client side scanner (which will execute client side).</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="overviewSummary" 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"> </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>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html" title="class in org.apache.accumulo.core.client">ClientSideIteratorScanner.ScannerTranslator</a></strong></code> +<div class="block">A class that wraps a Scanner in a SortedKeyValueIterator so that other accumulo iterators can use it as a source.</div> +</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 org.apache.accumulo.core.client.impl.ScannerOptions</h3> +<code>fetchedColumns, serverSideIteratorList, serverSideIteratorOptions</code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#ClientSideIteratorScanner(org.apache.accumulo.core.client.Scanner)">ClientSideIteratorScanner</a></strong>(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</code> +<div class="block">Constructs a scanner that can execute client-side iterators.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#disableIsolation()">disableIsolation</a></strong>()</code> +<div class="block">Disables row isolation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#enableIsolation()">enableIsolation</a></strong>()</code> +<div class="block">Enables row isolation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getBatchSize()">getBatchSize</a></strong>()</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 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><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getRange()">getRange</a></strong>()</code> +<div class="block">Returns the range of keys to scan over.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getTimeOut()">getTimeOut</a></strong>()</code> +<div class="block">Returns the setting for how long a scanner will automatically retry when a failure occurs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="http://docs.oracle.com/javase/6/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><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#iterator()">iterator</a></strong>()</code> +<div class="block">Returns an iterator over an accumulo table.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setBatchSize(int)">setBatchSize</a></strong>(int 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 class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setRange(org.apache.accumulo.core.data.Range)">setRange</a></strong>(<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> range)</code> +<div class="block">Sets the range of keys to scan over.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setSource(org.apache.accumulo.core.client.Scanner)">setSource</a></strong>(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</code> +<div class="block">Sets the source Scanner.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setTimeOut(int)">setTimeOut</a></strong>(int timeOut)</code> +<div class="block">This setting determines how long a scanner will automatically retry when a failure occurs.</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 org.apache.accumulo.core.client.impl.ScannerOptions</h3> +<code>addScanIterator, clearColumns, clearScanIterators, fetchColumn, fetchColumn, fetchColumnFamily, getFetchedColumns, removeScanIterator, setColumnFamilyRegex, setColumnQualifierRegex, setOptions, setRowRegex, setScanIteratorOption, setScanIterators, setupRegex, setValueRegex, 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 java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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 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#clearColumns()">clearColumns</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearScanIterators()">clearScanIterators</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn(org.apache.hadoop.io.Text,%20org.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#removeScanIterator(java.lang.String)">removeScanIterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setColumnFamilyRegex(java.lang.String)">setColumnFamilyRegex</a>, <a href="../../../../../org/ap ache/accumulo/core/client/ScannerBase.html#setColumnQualifierRegex(java.lang.String)">setColumnQualifierRegex</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setRowRegex(java.lang.String)">setRowRegex</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setScanIteratorOption(java.lang.String,%20java.lang.String,%20java.lang.String)">setScanIteratorOption</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setScanIterators(int,%20java.lang.String,%20java.lang.String)">setScanIterators</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setupRegex(java.lang.String,%20int)">setupRegex</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setValueRegex(java.lang.String)">setValueRegex</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#updateScanIteratorOption(java.lang.String,%20java.lang.String,%20java.lang.String)">updateScanIter atorOption</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="ClientSideIteratorScanner(org.apache.accumulo.core.client.Scanner)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ClientSideIteratorScanner</h4> +<pre>public ClientSideIteratorScanner(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</pre> +<div class="block">Constructs a scanner that can execute client-side iterators.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanner</code> - the source scanner</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setSource(org.apache.accumulo.core.client.Scanner)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSource</h4> +<pre>public void setSource(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</pre> +<div class="block">Sets the source Scanner.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanner</code> - </dd></dl> +</li> +</ul> +<a name="iterator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="http://docs.oracle.com/javase/6/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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator()">ScannerBase</a></code></strong></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. + + Keys returned by the iterator are not guaranteed to be in sorted order.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/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="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://docs.oracle.com/javase/6/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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator()">iterator</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>iterator</code> in class <code>org.apache.accumulo.core.client.impl.ScannerOptions</code></dd> +<dt><span class="strong">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>public void setTimeOut(int timeOut)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setTimeOut(int)">Scanner</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setTimeOut(int)">setTimeOut</a></code> in interface <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="strong">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>public int getTimeOut()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getTimeOut()">Scanner</a></code></strong></div> +<div class="block">Returns the setting for how long a scanner will automatically retry when a failure occurs.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getTimeOut()">getTimeOut</a></code> in interface <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="strong">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 void setRange(<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> range)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setRange(org.apache.accumulo.core.data.Range)">Scanner</a></code></strong></div> +<div class="block">Sets the range of keys to scan over.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setRange(org.apache.accumulo.core.data.Range)">setRange</a></code> in interface <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="strong">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 <a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> getRange()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getRange()">Scanner</a></code></strong></div> +<div class="block">Returns the range of keys to scan over.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getRange()">getRange</a></code> in interface <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="strong">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 void setBatchSize(int size)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setBatchSize(int)">Scanner</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setBatchSize(int)">setBatchSize</a></code> in interface <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="strong">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 int getBatchSize()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getBatchSize()">Scanner</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getBatchSize()">getBatchSize</a></code> in interface <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="strong">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 void enableIsolation()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#enableIsolation()">Scanner</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#enableIsolation()">enableIsolation</a></code> in interface <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="blockListLast"> +<li class="blockList"> +<h4>disableIsolation</h4> +<pre>public void disableIsolation()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#disableIsolation()">Scanner</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#disableIsolation()">disableIsolation</a></code> in interface <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> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ClientSideIteratorScanner.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/BatchWriter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ClientSideIteratorScanner.html" target="_top">Frames</a></li> +<li><a href="ClientSideIteratorScanner.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><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_org.apache.accumulo.core.client.impl.ScannerOptions">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
