http://git-wip-us.apache.org/repos/asf/accumulo/blob/823e2294/1.4/apidocs/org/apache/accumulo/core/client/RowIterator.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/RowIterator.html b/1.4/apidocs/org/apache/accumulo/core/client/RowIterator.html new file mode 100644 index 0000000..db17601 --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/RowIterator.html @@ -0,0 +1,354 @@ +<!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>RowIterator (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="RowIterator (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/RowIterator.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/MutationsRejectedException.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/Scanner.html" title="interface 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/RowIterator.html" target="_top">Frames</a></li> +<li><a href="RowIterator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client</div> +<h2 title="Class RowIterator" class="title">Class RowIterator</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.RowIterator</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/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/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>>>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RowIterator</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 <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/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>>>></pre> +<div class="block">Group Key/Value pairs into Iterators over rows. Suggested usage: + + <pre> + RowIterator rowIterator = new RowIterator(connector.createScanner(tableName, authorizations)); + </pre></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="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/RowIterator.html#RowIterator(java.lang.Iterable)">RowIterator</a></strong>(<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>>> iterable)</code> +<div class="block">Create an iterator from an Iterable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/RowIterator.html#RowIterator(java.util.Iterator)">RowIterator</a></strong>(<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)</code> +<div class="block">Create an iterator from an (ordered) sequence of KeyValue pairs.</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/RowIterator.html#getKVCount()">getKVCount</a></strong>()</code> +<div class="block">Get a count of the total number of entries in all rows read so far.</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/RowIterator.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if there is at least one more row to get.</div> +</td> +</tr> +<tr class="altColor"> +<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/RowIterator.html#next()">next</a></strong>()</code> +<div class="block">Fetch the next row.</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/RowIterator.html#remove()">remove</a></strong>()</code> +<div class="block">Unsupported.</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RowIterator(java.util.Iterator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RowIterator</h4> +<pre>public RowIterator(<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">Create an iterator from an (ordered) sequence of KeyValue pairs.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - </dd></dl> +</li> +</ul> +<a name="RowIterator(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RowIterator</h4> +<pre>public RowIterator(<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>>> iterable)</pre> +<div class="block">Create an iterator from an Iterable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterable</code> - </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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext()</pre> +<div class="block">Returns true if there is at least one more row to get. + + If the last row hasn't been fully read, this method will read through the end of the last row so it can determine if the underlying iterator has a next + row. The last row is disabled from future use.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#hasNext()" title="class or interface in java.util">hasNext</a></code> in interface <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/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></dd> +</dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</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>>> next()</pre> +<div class="block">Fetch the next row.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util">next</a></code> in interface <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/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></dd> +</dl> +</li> +</ul> +<a name="remove()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public void remove()</pre> +<div class="block">Unsupported.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true#remove()" title="class or interface in java.util">remove</a></code> in interface <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/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></dd> +</dl> +</li> +</ul> +<a name="getKVCount()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getKVCount</h4> +<pre>public long getKVCount()</pre> +<div class="block">Get a count of the total number of entries in all rows read so far.</div> +</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/RowIterator.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/MutationsRejectedException.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/Scanner.html" title="interface 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/RowIterator.html" target="_top">Frames</a></li> +<li><a href="RowIterator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>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/Scanner.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/Scanner.html b/1.4/apidocs/org/apache/accumulo/core/client/Scanner.html new file mode 100644 index 0000000..65b2935 --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/Scanner.html @@ -0,0 +1,350 @@ +<!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>Scanner (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="Scanner (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/Scanner.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/RowIterator.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/ScannerBase.html" title="interface 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/Scanner.html" target="_top">Frames</a></li> +<li><a href="Scanner.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 Scanner" class="title">Interface Scanner</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</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/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</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/MockScanner.html" title="class in org.apache.accumulo.core.client.mock">MockScanner</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Scanner</span> +extends <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></pre> +<div class="block">Scans a table over a given range. + + "Clients can iterate over multiple column families, and there are several mechanisms for limiting the rows, columns, and timestamps traversed by a scan. For + example, we could restrict [a] scan ... to only produce anchors whose columns match [a] regular expression ..., or to only produce anchors whose timestamps + fall within ten days of the current time."</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="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/Scanner.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/Scanner.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/Scanner.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/Scanner.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/Scanner.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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/Scanner.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="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/Scanner.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="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/Scanner.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.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#iterator()">iterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#removeScanIterator(java.lang.String)">removeScanIterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.ht ml#setColumnFamilyRegex(java.lang.String)">setColumnFamilyRegex</a>, <a href="../../../../../org/apache/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)">updateScanIteratorOption</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="setTimeOut(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTimeOut</h4> +<pre>void setTimeOut(int timeOut)</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.</div> +<dl><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>int getTimeOut()</pre> +<div class="block">Returns the setting for how long a scanner will automatically retry when a failure occurs.</div> +<dl><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>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">Sets the range of keys to scan over.</div> +<dl><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><a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> getRange()</pre> +<div class="block">Returns the range of keys to scan over.</div> +<dl><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>void setBatchSize(int size)</pre> +<div class="block">Sets the number of Key/Value pairs that will be fetched at a time from a tablet server.</div> +<dl><dt><span class="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>int getBatchSize()</pre> +<div class="block">Returns the batch size (number of Key/Value pairs) that will be fetched at a time from a tablet server.</div> +<dl><dt><span class="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>void enableIsolation()</pre> +<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> +</li> +</ul> +<a name="disableIsolation()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>disableIsolation</h4> +<pre>void disableIsolation()</pre> +<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> +</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/Scanner.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/RowIterator.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/ScannerBase.html" title="interface 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/Scanner.html" target="_top">Frames</a></li> +<li><a href="Scanner.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 © 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/ScannerBase.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/ScannerBase.html b/1.4/apidocs/org/apache/accumulo/core/client/ScannerBase.html new file mode 100644 index 0000000..5a6ebc7 --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/ScannerBase.html @@ -0,0 +1,546 @@ +<!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>ScannerBase (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="ScannerBase (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/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="strong">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="strong">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="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>>></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.ScannerOptio ns</dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ScannerBase</span> +extends <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>>></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="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/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)">addScanIterator</a></strong>(<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 class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearColumns()">clearColumns</a></strong>()</code> +<div class="block">Clears the columns to be fetched (useful for resetting the scanner for reuse).</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/ScannerBase.html#clearScanIterators()">clearScanIterators</a></strong>()</code> +<div class="block">Clears scan iterators prior to returning a scanner to the pool.</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/ScannerBase.html#fetchColumn(org.apache.hadoop.io.Text,%20org.apache.hadoop.io.Text)">fetchColumn</a></strong>(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 class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumnFamily(org.apache.hadoop.io.Text)">fetchColumnFamily</a></strong>(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 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/ScannerBase.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/ScannerBase.html#removeScanIterator(java.lang.String)">removeScanIterator</a></strong>(<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> iteratorName)</code> +<div class="block">Remove an iterator from the list of iterators.</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/ScannerBase.html#setColumnFamilyRegex(java.lang.String)">setColumnFamilyRegex</a></strong>(<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> regex)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code></i></div> +</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/ScannerBase.html#setColumnQualifierRegex(java.lang.String)">setColumnQualifierRegex</a></strong>(<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> regex)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code></i></div> +</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/ScannerBase.html#setRowRegex(java.lang.String)">setRowRegex</a></strong>(<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> regex)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code> + + <pre> + // Use the more flexible addScanIterator method: + ScanIterator cfg = new ScanIterator("regex", RegexIterator.class); + RegexIterator.setRegexs(cfg, row, null, null, null, false); + scanner.addScanIterator(priority, cfg); + </pre></i></div> +</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/ScannerBase.html#setScanIteratorOption(java.lang.String,%20java.lang.String,%20java.lang.String)">setScanIteratorOption</a></strong>(<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> iteratorName, + <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> key, + <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> value)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a>.</i></div> +</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/ScannerBase.html#setScanIterators(int,%20java.lang.String,%20java.lang.String)">setScanIterators</a></strong>(int priority, + <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> iteratorClass, + <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> iteratorName)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a>.</i></div> +</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/ScannerBase.html#setupRegex(java.lang.String,%20int)">setupRegex</a></strong>(<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> iteratorName, + int iteratorPriority)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code></i></div> +</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/ScannerBase.html#setValueRegex(java.lang.String)">setValueRegex</a></strong>(<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> regex)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code></i></div> +</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/ScannerBase.html#updateScanIteratorOption(java.lang.String,%20java.lang.String,%20java.lang.String)">updateScanIteratorOption</a></strong>(<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> iteratorName, + <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> key, + <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> value)</code> +<div class="block">Update the options for an iterator.</div> +</td> +</tr> +</table> +</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="strong">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="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/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="http://docs.oracle.com/javase/6/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="strong">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="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> iteratorName, + <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> key, + <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> 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="strong">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="setScanIterators(int, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setScanIterators</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +void setScanIterators(int priority, + <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> iteratorClass, + <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> iteratorName) + 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"><span class="strong">Deprecated.</span> <i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a>.</i></div> +<dl><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></dd></dl> +</li> +</ul> +<a name="setScanIteratorOption(java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setScanIteratorOption</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +void setScanIteratorOption(<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> iteratorName, + <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> key, + <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> value)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a>.</i></div> +</li> +</ul> +<a name="setupRegex(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setupRegex</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +void setupRegex(<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> iteratorName, + int iteratorPriority) + 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"><span class="strong">Deprecated.</span> <i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code></i></div> +<div class="block">Call this method to initialize regular expressions on a scanner. If it is not called, reasonable defaults will be used.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iteratorName</code> - a nickname for the iterator</dd><dd><code>iteratorPriority</code> - determines the order in which iterators are applied (system iterators are always applied first, then per-table and scan-time, lowest first)</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 exception occurs reading from the iterator stack</dd></dl> +</li> +</ul> +<a name="setRowRegex(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRowRegex</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +void setRowRegex(<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> regex)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code> + + <pre> + // Use the more flexible addScanIterator method: + ScanIterator cfg = new ScanIterator("regex", RegexIterator.class); + RegexIterator.setRegexs(cfg, row, null, null, null, false); + scanner.addScanIterator(priority, cfg); + </pre></i></div> +<div class="block">Set a row regular expression that filters non matching entries server side.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - java regular expression to match</dd></dl> +</li> +</ul> +<a name="setColumnFamilyRegex(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setColumnFamilyRegex</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +void setColumnFamilyRegex(<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> regex)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code></i></div> +<div class="block">Set a column family regular expression that filters non matching entries server side.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - java regular expression to match</dd></dl> +</li> +</ul> +<a name="setColumnQualifierRegex(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setColumnQualifierRegex</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +void setColumnQualifierRegex(<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> regex)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code></i></div> +<div class="block">Use addScanIterator(int, ScanIterator); + + Set a column qualifier regular expression that filters non matching entries server side.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - java regular expression to match</dd></dl> +</li> +</ul> +<a name="setValueRegex(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValueRegex</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +void setValueRegex(<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> regex)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Since 1.4, use <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)"><code>addScanIterator(org.apache.accumulo.core.client.IteratorSetting)</code></a> and + <code>RegExFilter</code></i></div> +<div class="block">Set a value regular expression that filters non matching entries server side.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - java regular expression to match</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.</div> +<dl><dt><span class="strong">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.</div> +<dl><dt><span class="strong">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="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="blockListLast"> +<li class="blockList"> +<h4>iterator</h4> +<pre><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">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><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> +</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/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="strong">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="strong">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 © 2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
