http://git-wip-us.apache.org/repos/asf/accumulo/blob/823e2294/1.4/apidocs/org/apache/accumulo/core/client/mock/MockInstanceOperations.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/mock/MockInstanceOperations.html b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockInstanceOperations.html new file mode 100644 index 0000000..f960910 --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockInstanceOperations.html @@ -0,0 +1,428 @@ +<!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:23 EST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MockInstanceOperations (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="MockInstanceOperations (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/MockInstanceOperations.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/mock/MockInstance.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mock/MockInstanceOperations.html" target="_top">Frames</a></li> +<li><a href="MockInstanceOperations.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.mock</div> +<h2 title="Class MockInstanceOperations" class="title">Class MockInstanceOperations</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.mock.MockInstanceOperations</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MockInstanceOperations</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="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></pre> +</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/mock/MockInstanceOperations.html#MockInstanceOperations(org.apache.accumulo.core.client.mock.MockAccumulo)">MockInstanceOperations</a></strong>(<a href="../../../../../../org/apache/accumulo/core/client/mock/MockAccumulo.html" title="class in org.apache.accumulo.core.client.mock">MockAccumulo</a> acu)</code> </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><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveScan.html" title="class in org.apache.accumulo.core.client.admin">ActiveScan</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mock/MockInstanceOperations.html#getActiveScans(java.lang.String)">getActiveScans</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> tserver)</code> +<div class="block">List the active scans on tablet server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mock/MockInstanceOperations.html#getSiteConfiguration()">getSiteConfiguration</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mock/MockInstanceOperations.html#getSystemConfiguration()">getSystemConfiguration</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mock/MockInstanceOperations.html#getTabletServers()">getTabletServers</a></strong>()</code> +<div class="block">List the currently active tablet servers participating in the accumulo instance</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/mock/MockInstanceOperations.html#removeProperty(java.lang.String)">removeProperty</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> property)</code> +<div class="block">Removes a system property from zookeeper.</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/mock/MockInstanceOperations.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</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> property, + <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">Sets an system property in zookeeper.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mock/MockInstanceOperations.html#testClassLoad(java.lang.String,%20java.lang.String)">testClassLoad</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> className, + <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> asTypeName)</code> +<div class="block">Test to see if the instance can load the given class as the given type.</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="MockInstanceOperations(org.apache.accumulo.core.client.mock.MockAccumulo)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MockInstanceOperations</h4> +<pre>public MockInstanceOperations(<a href="../../../../../../org/apache/accumulo/core/client/mock/MockAccumulo.html" title="class in org.apache.accumulo.core.client.mock">MockAccumulo</a> acu)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>acu</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="setProperty(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProperty</h4> +<pre>public void setProperty(<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> property, + <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) + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#setProperty(java.lang.String,%20java.lang.String)">InstanceOperations</a></code></strong></div> +<div class="block">Sets an system property in zookeeper. Tablet servers will pull this setting and override the equivalent setting in accumulo-site.xml. Changes can be seen + using <a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getSystemConfiguration()"><code>InstanceOperations.getSystemConfiguration()</code></a></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#setProperty(java.lang.String,%20java.lang.String)">setProperty</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - the name of a per-table property</dd><dd><code>value</code> - the value to set a per-table property to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code> - if a general error occurs</dd> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code> - if the user does not have permission</dd></dl> +</li> +</ul> +<a name="removeProperty(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeProperty</h4> +<pre>public void removeProperty(<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> property) + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#removeProperty(java.lang.String)">InstanceOperations</a></code></strong></div> +<div class="block">Removes a system property from zookeeper. Changes can be seen using <a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getSystemConfiguration()"><code>InstanceOperations.getSystemConfiguration()</code></a></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#removeProperty(java.lang.String)">removeProperty</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - the name of a per-table property</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code> - if a general error occurs</dd> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code> - if the user does not have permission</dd></dl> +</li> +</ul> +<a name="getSystemConfiguration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSystemConfiguration</h4> +<pre>public <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>> getSystemConfiguration() + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getSystemConfiguration()">getSystemConfiguration</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>A map of system properties set in zookeeper. If a property is not set in zookeeper, then it will return the value set in accumulo-site.xml on some + server. If nothing is set in an accumulo-site.xml file it will return the default value for each property.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code></dd> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd></dl> +</li> +</ul> +<a name="getSiteConfiguration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSiteConfiguration</h4> +<pre>public <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>> getSiteConfiguration() + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getSiteConfiguration()">getSiteConfiguration</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>A map of system properties set in accumulo-site.xml on some server. If nothing is set in an accumulo-site.xml file it will return the default value + for each property.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code></dd> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd></dl> +</li> +</ul> +<a name="getTabletServers()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTabletServers</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>> getTabletServers()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getTabletServers()">InstanceOperations</a></code></strong></div> +<div class="block">List the currently active tablet servers participating in the accumulo instance</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getTabletServers()">getTabletServers</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>A list of currently active tablet servers.</dd></dl> +</li> +</ul> +<a name="getActiveScans(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveScans</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/accumulo/core/client/admin/ActiveScan.html" title="class in org.apache.accumulo.core.client.admin">ActiveScan</a>> getActiveScans(<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> tserver) + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getActiveScans(java.lang.String)">InstanceOperations</a></code></strong></div> +<div class="block">List the active scans on tablet server.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#getActiveScans(java.lang.String)">getActiveScans</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>tserver</code> - The tablet server address should be of the form <ip address>:<port></dd> +<dt><span class="strong">Returns:</span></dt><dd>A list of active scans on tablet server.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code></dd> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd></dl> +</li> +</ul> +<a name="testClassLoad(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>testClassLoad</h4> +<pre>public boolean testClassLoad(<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> className, + <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> asTypeName) + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#testClassLoad(java.lang.String,%20java.lang.String)">InstanceOperations</a></code></strong></div> +<div class="block">Test to see if the instance can load the given class as the given type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html#testClassLoad(java.lang.String,%20java.lang.String)">testClassLoad</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/admin/InstanceOperations.html" title="interface in org.apache.accumulo.core.client.admin">InstanceOperations</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the instance can load the given class as the given type, false otherwise</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code></dd> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</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/MockInstanceOperations.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/mock/MockInstance.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mock/MockInstanceOperations.html" target="_top">Frames</a></li> +<li><a href="MockInstanceOperations.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/mock/MockMultiTableBatchWriter.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html new file mode 100644 index 0000000..f475701 --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html @@ -0,0 +1,346 @@ +<!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:23 EST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MockMultiTableBatchWriter (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="MockMultiTableBatchWriter (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/MockMultiTableBatchWriter.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/mock/MockInstanceOperations.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScanner.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html" target="_top">Frames</a></li> +<li><a href="MockMultiTableBatchWriter.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.mock</div> +<h2 title="Class MockMultiTableBatchWriter" class="title">Class MockMultiTableBatchWriter</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.mock.MockMultiTableBatchWriter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html" title="interface in org.apache.accumulo.core.client">MultiTableBatchWriter</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MockMultiTableBatchWriter</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="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html" title="interface in org.apache.accumulo.core.client">MultiTableBatchWriter</a></pre> +</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/mock/MockMultiTableBatchWriter.html#MockMultiTableBatchWriter(org.apache.accumulo.core.client.mock.MockAccumulo)">MockMultiTableBatchWriter</a></strong>(<a href="../../../../../../org/apache/accumulo/core/client/mock/MockAccumulo.html" title="class in org.apache.accumulo.core.client.mock">MockAccumulo</a> acu)</code> </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/mock/MockMultiTableBatchWriter.html#close()">close</a></strong>()</code> +<div class="block">Flush and release all resources.</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/mock/MockMultiTableBatchWriter.html#flush()">flush</a></strong>()</code> +<div class="block">Send mutations for all tables to accumulo.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html#getBatchWriter(java.lang.String)">getBatchWriter</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> table)</code> +<div class="block">Returns a BatchWriter for a particular table.</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/mock/MockMultiTableBatchWriter.html#isClosed()">isClosed</a></strong>()</code> +<div class="block">Returns true if this batch writer has been closed.</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="MockMultiTableBatchWriter(org.apache.accumulo.core.client.mock.MockAccumulo)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MockMultiTableBatchWriter</h4> +<pre>public MockMultiTableBatchWriter(<a href="../../../../../../org/apache/accumulo/core/client/mock/MockAccumulo.html" title="class in org.apache.accumulo.core.client.mock">MockAccumulo</a> acu)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getBatchWriter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBatchWriter</h4> +<pre>public <a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</a> getBatchWriter(<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> table) + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a>, + <a href="../../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html#getBatchWriter(java.lang.String)">MultiTableBatchWriter</a></code></strong></div> +<div class="block">Returns a BatchWriter for a particular table.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html#getBatchWriter(java.lang.String)">getBatchWriter</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html" title="interface in org.apache.accumulo.core.client">MultiTableBatchWriter</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>table</code> - the name of a table whose batch writer you wish to retrieve</dd> +<dt><span class="strong">Returns:</span></dt><dd>an instance of a batch writer for the specified table</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code> - when a general exception occurs with accumulo</dd> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code> - when the user is not allowed to insert data into that table</dd> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></code> - when the table does not exist</dd></dl> +</li> +</ul> +<a name="flush()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flush</h4> +<pre>public void flush() + throws <a href="../../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html#flush()">MultiTableBatchWriter</a></code></strong></div> +<div class="block">Send mutations for all tables to accumulo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html#flush()">flush</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html" title="interface in org.apache.accumulo.core.client">MultiTableBatchWriter</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</a></code> - when queued mutations are unable to be inserted</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws <a href="../../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html#close()">MultiTableBatchWriter</a></code></strong></div> +<div class="block">Flush and release all resources.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html#close()">close</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html" title="interface in org.apache.accumulo.core.client">MultiTableBatchWriter</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</a></code> - when queued mutations are unable to be inserted</dd></dl> +</li> +</ul> +<a name="isClosed()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public boolean isClosed()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html#isClosed()">MultiTableBatchWriter</a></code></strong></div> +<div class="block">Returns true if this batch writer has been closed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html#isClosed()">isClosed</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html" title="interface in org.apache.accumulo.core.client">MultiTableBatchWriter</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if this batch writer has been closed</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/MockMultiTableBatchWriter.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/mock/MockInstanceOperations.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScanner.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html" target="_top">Frames</a></li> +<li><a href="MockMultiTableBatchWriter.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/mock/MockScanner.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/mock/MockScanner.html b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockScanner.html new file mode 100644 index 0000000..06455c9 --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockScanner.html @@ -0,0 +1,465 @@ +<!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:23 EST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MockScanner (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="MockScanner (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/MockScanner.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/mock/MockMultiTableBatchWriter.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mock/MockScanner.html" target="_top">Frames</a></li> +<li><a href="MockScanner.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="#fields_inherited_from_class_org.apache.accumulo.core.client.mock.MockScannerBase">Field</a> | </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.mock</div> +<h2 title="Class MockScanner" class="title">Class MockScanner</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><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html" title="class in org.apache.accumulo.core.client.mock">org.apache.accumulo.core.client.mock.MockScannerBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.mock.MockScanner</li> +</ul> +</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">MockScanner</span> +extends <a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html" title="class in org.apache.accumulo.core.client.mock">MockScannerBase</a> +implements <a href="../../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></pre> +</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> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.accumulo.core.client.mock.MockScannerBase"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.accumulo.core.client.mock.<a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html" title="class in org.apache.accumulo.core.client.mock">MockScannerBase</a></h3> +<code><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html#auths">auths</a>, <a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html#table">table</a></code></li> +</ul> +<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> +<!-- ========== 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/mock/MockScanner.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/mock/MockScanner.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/mock/MockScanner.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/mock/MockScanner.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/mock/MockScanner.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/mock/MockScanner.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/mock/MockScanner.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/mock/MockScanner.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/mock/MockScanner.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.mock.MockScannerBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.accumulo.core.client.mock.<a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html" title="class in org.apache.accumulo.core.client.mock">MockScannerBase</a></h3> +<code><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html#createFilter(org.apache.accumulo.core.iterators.SortedKeyValueIterator)">createFilter</a></code></li> +</ul> +<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/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.S tring,%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>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="blockList"> +<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> +<a name="iterator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<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><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html#iterator()">iterator</a></code> in class <code><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html" title="class in org.apache.accumulo.core.client.mock">MockScannerBase</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/MockScanner.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/mock/MockMultiTableBatchWriter.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mock/MockScannerBase.html" title="class in org.apache.accumulo.core.client.mock"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mock/MockScanner.html" target="_top">Frames</a></li> +<li><a href="MockScanner.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="#fields_inherited_from_class_org.apache.accumulo.core.client.mock.MockScannerBase">Field</a> | </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>
