http://git-wip-us.apache.org/repos/asf/accumulo/blob/823e2294/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchDeleter.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchDeleter.html b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchDeleter.html new file mode 100644 index 0000000..7af176f --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchDeleter.html @@ -0,0 +1,362 @@ +<!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>MockBatchDeleter (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="MockBatchDeleter (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/MockBatchDeleter.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/MockAccumulo.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/MockBatchScanner.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/MockBatchDeleter.html" target="_top">Frames</a></li> +<li><a href="MockBatchDeleter.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><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 MockBatchDeleter" class="title">Class MockBatchDeleter</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><a href="../../../../../../org/apache/accumulo/core/client/mock/MockBatchScanner.html" title="class in org.apache.accumulo.core.client.mock">org.apache.accumulo.core.client.mock.MockBatchScanner</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.mock.MockBatchDeleter</li> +</ul> +</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/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/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBas e</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MockBatchDeleter</span> +extends <a href="../../../../../../org/apache/accumulo/core/client/mock/MockBatchScanner.html" title="class in org.apache.accumulo.core.client.mock">MockBatchScanner</a> +implements <a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client">BatchDeleter</a></pre> +<div class="block"><a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client"><code>BatchDeleter</code></a> for a <a href="../../../../../../org/apache/accumulo/core/client/mock/MockAccumulo.html" title="class in org.apache.accumulo.core.client.mock"><code>MockAccumulo</code></a> instance. Behaves similarly to a regular <a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client"><code>BatchDeleter</code></a>, with a few exceptions: + <ol> + <li>There is no waiting for memory to fill before flushing</li> + <li>Only one thread is used for writing</li> + </ol> + + Otherwise, it behaves as expected.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<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> +<!-- ======== 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/MockBatchDeleter.html#MockBatchDeleter(org.apache.accumulo.core.client.mock.MockAccumulo,%20java.lang.String,%20org.apache.accumulo.core.security.Authorizations)">MockBatchDeleter</a></strong>(<a href="../../../../../../org/apache/accumulo/core/client/mock/MockAccumulo.html" title="class in org.apache.accumulo.core.client.mock">MockAccumulo</a> acc, + <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> tableName, + <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> auths)</code> +<div class="block">Create a <a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client"><code>BatchDeleter</code></a> for the specified instance on the specified table where the writer uses the specified <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security"><code>Authorizations</code></a>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mock/MockBatchDeleter.html#delete()">delete</a></strong>()</code> +<div class="block">Deletes the ranges specified by <a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html#setRanges(java.util.Collection)"><code>BatchDeleter.setRanges(java.util.Collection<org.apache.accumulo.core.data.Range>)</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.accumulo.core.client.mock.MockBatchScanner"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.accumulo.core.client.mock.<a href="../../../../../../org/apache/accumulo/core/client/mock/MockBatchScanner.html" title="class in org.apache.accumulo.core.client.mock">MockBatchScanner</a></h3> +<code><a href="../../../../../../org/apache/accumulo/core/client/mock/MockBatchScanner.html#close()">close</a>, <a href="../../../../../../org/apache/accumulo/core/client/mock/MockBatchScanner.html#iterator()">iterator</a>, <a href="../../../../../../org/apache/accumulo/core/client/mock/MockBatchScanner.html#setRanges(java.util.Collection)">setRanges</a></code></li> +</ul> +<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.BatchDeleter"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.accumulo.core.client.<a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client">BatchDeleter</a></h3> +<code><a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html#close()">close</a>, <a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html#setRanges(java.util.Collection)">setRanges</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#iterator()">iterator</a>, <a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html#removeScanIterator(java.lang.String)">removeScanIterator</a>, <a href="../../../../../../org/apache/accumulo/co re/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.String,%20java.lang.String)">updateScanIteratorOption</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="MockBatchDeleter(org.apache.accumulo.core.client.mock.MockAccumulo, java.lang.String, org.apache.accumulo.core.security.Authorizations)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MockBatchDeleter</h4> +<pre>public MockBatchDeleter(<a href="../../../../../../org/apache/accumulo/core/client/mock/MockAccumulo.html" title="class in org.apache.accumulo.core.client.mock">MockAccumulo</a> acc, + <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> tableName, + <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> auths)</pre> +<div class="block">Create a <a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client"><code>BatchDeleter</code></a> for the specified instance on the specified table where the writer uses the specified <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security"><code>Authorizations</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>acc</code> - </dd><dd><code>tableName</code> - </dd><dd><code>auths</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="delete()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>delete</h4> +<pre>public void delete() + throws <a href="../../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</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/BatchDeleter.html#delete()">BatchDeleter</a></code></strong></div> +<div class="block">Deletes the ranges specified by <a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html#setRanges(java.util.Collection)"><code>BatchDeleter.setRanges(java.util.Collection<org.apache.accumulo.core.data.Range>)</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html#delete()">delete</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client">BatchDeleter</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> - this can be thrown when deletion mutations fail</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> +</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/MockBatchDeleter.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/MockAccumulo.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/MockBatchScanner.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/MockBatchDeleter.html" target="_top">Frames</a></li> +<li><a href="MockBatchDeleter.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><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/MockBatchScanner.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchScanner.html b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchScanner.html new file mode 100644 index 0000000..02cd34d --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchScanner.html @@ -0,0 +1,379 @@ +<!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>MockBatchScanner (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="MockBatchScanner (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/MockBatchScanner.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/MockBatchDeleter.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/MockBatchWriter.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/MockBatchScanner.html" target="_top">Frames</a></li> +<li><a href="MockBatchScanner.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><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 MockBatchScanner" class="title">Class MockBatchScanner</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.MockBatchScanner</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/BatchScanner.html" title="interface in org.apache.accumulo.core.client">BatchScanner</a>, <a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/mock/MockBatchDeleter.html" title="class in org.apache.accumulo.core.client.mock">MockBatchDeleter</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MockBatchScanner</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/BatchScanner.html" title="interface in org.apache.accumulo.core.client">BatchScanner</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> +<!-- ======== 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/MockBatchScanner.html#MockBatchScanner(org.apache.accumulo.core.client.mock.MockTable,%20org.apache.accumulo.core.security.Authorizations)">MockBatchScanner</a></strong>(<a href="../../../../../../org/apache/accumulo/core/client/mock/MockTable.html" title="class in org.apache.accumulo.core.client.mock">MockTable</a> mockTable, + <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> authorizations)</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/MockBatchScanner.html#close()">close</a></strong>()</code> +<div class="block">Cleans up and finalizes the 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/mock/MockBatchScanner.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/MockBatchScanner.html#setRanges(java.util.Collection)">setRanges</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> ranges)</code> +<div class="block">Allows scanning over multiple ranges efficiently.</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="MockBatchScanner(org.apache.accumulo.core.client.mock.MockTable, org.apache.accumulo.core.security.Authorizations)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MockBatchScanner</h4> +<pre>public MockBatchScanner(<a href="../../../../../../org/apache/accumulo/core/client/mock/MockTable.html" title="class in org.apache.accumulo.core.client.mock">MockTable</a> mockTable, + <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> authorizations)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setRanges(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRanges</h4> +<pre>public void setRanges(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> ranges)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html#setRanges(java.util.Collection)">BatchScanner</a></code></strong></div> +<div class="block">Allows scanning over multiple ranges efficiently.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html#setRanges(java.util.Collection)">setRanges</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client">BatchScanner</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>ranges</code> - specifies the non-overlapping ranges to query</dd></dl> +</li> +</ul> +<a name="iterator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a><<a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iterator()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator()">ScannerBase</a></code></strong></div> +<div class="block">Returns an iterator over an accumulo table. This iterator uses the options that are currently set for its lifetime, so setting options will have no effect + on existing iterators. + + Keys returned by the iterator are not guaranteed to be in sorted order.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util">Map.Entry</a><<a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator()">iterator</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><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> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html#close()">BatchScanner</a></code></strong></div> +<div class="block">Cleans up and finalizes the scanner</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html#close()">close</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client">BatchScanner</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/MockBatchScanner.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/MockBatchDeleter.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/MockBatchWriter.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/MockBatchScanner.html" target="_top">Frames</a></li> +<li><a href="MockBatchScanner.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><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/MockBatchWriter.html ---------------------------------------------------------------------- diff --git a/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchWriter.html b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchWriter.html new file mode 100644 index 0000000..4e0e376 --- /dev/null +++ b/1.4/apidocs/org/apache/accumulo/core/client/mock/MockBatchWriter.html @@ -0,0 +1,310 @@ +<!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>MockBatchWriter (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="MockBatchWriter (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/MockBatchWriter.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/MockBatchScanner.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/MockConnector.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/MockBatchWriter.html" target="_top">Frames</a></li> +<li><a href="MockBatchWriter.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.mock</div> +<h2 title="Class MockBatchWriter" class="title">Class MockBatchWriter</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.MockBatchWriter</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/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MockBatchWriter</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/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</a></pre> +</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/mock/MockBatchWriter.html#addMutation(org.apache.accumulo.core.data.Mutation)">addMutation</a></strong>(<a href="../../../../../../org/apache/accumulo/core/data/Mutation.html" title="class in org.apache.accumulo.core.data">Mutation</a> m)</code> +<div class="block">Queues one mutation to write.</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/MockBatchWriter.html#addMutations(java.lang.Iterable)">addMutations</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="../../../../../../org/apache/accumulo/core/data/Mutation.html" title="class in org.apache.accumulo.core.data">Mutation</a>> iterable)</code> +<div class="block">Queues several mutations to write.</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/MockBatchWriter.html#close()">close</a></strong>()</code> +<div class="block">Flush and release any 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/MockBatchWriter.html#flush()">flush</a></strong>()</code> +<div class="block">Send any buffered mutations to Accumulo immediately.</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addMutation(org.apache.accumulo.core.data.Mutation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addMutation</h4> +<pre>public void addMutation(<a href="../../../../../../org/apache/accumulo/core/data/Mutation.html" title="class in org.apache.accumulo.core.data">Mutation</a> m) + 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/BatchWriter.html#addMutation(org.apache.accumulo.core.data.Mutation)">BatchWriter</a></code></strong></div> +<div class="block">Queues one mutation to write.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html#addMutation(org.apache.accumulo.core.data.Mutation)">addMutation</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>m</code> - the mutation to add</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> - this could be thrown because current or previous mutations failed</dd></dl> +</li> +</ul> +<a name="addMutations(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addMutations</h4> +<pre>public void addMutations(<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="../../../../../../org/apache/accumulo/core/data/Mutation.html" title="class in org.apache.accumulo.core.data">Mutation</a>> iterable) + 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/BatchWriter.html#addMutations(java.lang.Iterable)">BatchWriter</a></code></strong></div> +<div class="block">Queues several mutations to write.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html#addMutations(java.lang.Iterable)">addMutations</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>iterable</code> - allows adding any number of mutations iteratively</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> - this could be thrown because current or previous mutations failed</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/BatchWriter.html#flush()">BatchWriter</a></code></strong></div> +<div class="block">Send any buffered mutations to Accumulo immediately.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html#flush()">flush</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</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> - this could be thrown because current or previous mutations failed</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<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/BatchWriter.html#close()">BatchWriter</a></code></strong></div> +<div class="block">Flush and release any resources.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html#close()">close</a></code> in interface <code><a href="../../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</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> - this could be thrown because current or previous mutations failed</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/MockBatchWriter.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/MockBatchScanner.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/MockConnector.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/MockBatchWriter.html" target="_top">Frames</a></li> +<li><a href="MockBatchWriter.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>
