http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/IteratorSetting.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/IteratorSetting.html b/1.8/apidocs/org/apache/accumulo/core/client/IteratorSetting.html new file mode 100644 index 0000000..5bfd9b2 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/IteratorSetting.html @@ -0,0 +1,711 @@ +<!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_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>IteratorSetting (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<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="IteratorSetting (Apache Accumulo Project 1.8.0 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/IteratorSetting.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/IsolatedScanner.RowBufferFactory.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/IteratorSetting.html" target="_top">Frames</a></li> +<li><a href="IteratorSetting.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client</div> +<h2 title="Class IteratorSetting" class="title">Class IteratorSetting</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.IteratorSetting</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.hadoop.io.Writable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IteratorSetting</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements org.apache.hadoop.io.Writable</pre> +<div class="block">Configure an iterator for minc, majc, and/or scan. By default, IteratorSetting will be configured for scan. + + Every iterator has a priority, a name, a class, a set of scopes, and configuration parameters. + + A typical use case configured for scan: + + <pre> + IteratorSetting cfg = new IteratorSetting(priority, "myIter", MyIterator.class); + MyIterator.addOption(cfg, 42); + scanner.addScanIterator(cfg); + </pre></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client">IteratorSetting.Column</a></strong></code> +<div class="block">A convenience class for passing column family and column qualifiers to iterator configuration methods.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#IteratorSetting(java.io.DataInput)">IteratorSetting</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataInput.html?is-external=true"; title="class or interface in java.io">DataInput</a> din)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#IteratorSetting(int,%20java.lang.Class)">IteratorSetting</a></strong>(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.accumulo.core.iterators.SortedKeyValueIterator<<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iteratorClass)</code> +<div class="block">Constructs an iterator setting using the given class's SimpleName for the iterator name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#IteratorSetting(int,%20java.lang.Class,%20java.util.Map)">IteratorSetting</a></strong>(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.accumulo.core.iterators.SortedKeyValueIterator<<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iteratorClass, + <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</code> +<div class="block">Constructs an iterator setting using the given class's SimpleName for the iterator name and configured for the specified scopes with the specified + parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#IteratorSetting(int,%20java.lang.String,%20java.lang.Class)">IteratorSetting</a></strong>(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.accumulo.core.iterators.SortedKeyValueIterator<<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iteratorClass)</code> +<div class="block">Constructs an iterator setting configured for the scan scope with no parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#IteratorSetting(int,%20java.lang.String,%20java.lang.Class,%20java.util.Map)">IteratorSetting</a></strong>(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.accumulo.core.iterators.SortedKeyValueIterator<<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iteratorClass, + <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</code> +<div class="block">Constructs an iterator setting using the provided name and the provided class's name for the scan scope with the provided parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#IteratorSetting(int,%20java.lang.String,%20java.lang.String)">IteratorSetting</a></strong>(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> iteratorClass)</code> +<div class="block">Constructs an iterator setting configured for the scan scope with no parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#IteratorSetting(int,%20java.lang.String,%20java.lang.String,%20java.util.Map)">IteratorSetting</a></strong>(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> iteratorClass, + <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</code> +<div class="block">Constructs an iterator setting configured for the specified scopes with the specified parameters.</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/IteratorSetting.html#addOption(java.lang.String,%20java.lang.String)">addOption</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> option, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</code> +<div class="block">Add another option to the iterator.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#addOptions(java.util.Map)">addOptions</a></strong>(<a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</code> +<div class="block">Add many options to the iterator.</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/IteratorSetting.html#addOptions(java.util.Set)">addOptions</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> propertyEntries)</code> +<div class="block">Add many options to the iterator.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#clearOptions()">clearOptions</a></strong>()</code> +<div class="block">Remove all options from the iterator.</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/IteratorSetting.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/IteratorSetting.html#getIteratorClass()">getIteratorClass</a></strong>()</code> +<div class="block">Get the name of the class that implements the iterator.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/IteratorSetting.html#getName()">getName</a></strong>()</code> +<div class="block">Get the iterator's name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/7/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/7/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/IteratorSetting.html#getOptions()">getOptions</a></strong>()</code> +<div class="block">Get the configuration parameters for this iterator.</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/IteratorSetting.html#getPriority()">getPriority</a></strong>()</code> +<div class="block">Get layer at which this iterator applies.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#readFields(java.io.DataInput)">readFields</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataInput.html?is-external=true"; title="class or interface in java.io">DataInput</a> din)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/IteratorSetting.html#removeOption(java.lang.String)">removeOption</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> option)</code> +<div class="block">Remove an option from the iterator.</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/IteratorSetting.html#setIteratorClass(java.lang.String)">setIteratorClass</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> iteratorClass)</code> +<div class="block">Set the name of the class that implements the iterator.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#setName(java.lang.String)">setName</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Set the iterator's name.</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/IteratorSetting.html#setPriority(int)">setPriority</a></strong>(int priority)</code> +<div class="block">Set layer at which this iterator applies.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/IteratorSetting.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#write(java.io.DataOutput)">write</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutput.html?is-external=true"; title="class or interface in java.io">DataOutput</a> dout)</code> </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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-ex ternal=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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="IteratorSetting(int, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IteratorSetting</h4> +<pre>public IteratorSetting(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> iteratorClass)</pre> +<div class="block">Constructs an iterator setting configured for the scan scope with no parameters. (Parameters can be added later.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - the priority for the iterator (see <a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#setPriority(int)"><code>setPriority(int)</code></a>)</dd><dd><code>name</code> - the distinguishing name for the iterator</dd><dd><code>iteratorClass</code> - the fully qualified class name for the iterator</dd></dl> +</li> +</ul> +<a name="IteratorSetting(int, java.lang.String, java.lang.String, java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IteratorSetting</h4> +<pre>public IteratorSetting(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> iteratorClass, + <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</pre> +<div class="block">Constructs an iterator setting configured for the specified scopes with the specified parameters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - the priority for the iterator (see <a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#setPriority(int)"><code>setPriority(int)</code></a>)</dd><dd><code>name</code> - the distinguishing name for the iterator</dd><dd><code>iteratorClass</code> - the fully qualified class name for the iterator</dd><dd><code>properties</code> - any properties for the iterator</dd></dl> +</li> +</ul> +<a name="IteratorSetting(int, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IteratorSetting</h4> +<pre>public IteratorSetting(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.accumulo.core.iterators.SortedKeyValueIterator<<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iteratorClass)</pre> +<div class="block">Constructs an iterator setting using the given class's SimpleName for the iterator name. The iterator setting will be configured for the scan scope with no + parameters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - the priority for the iterator (see <a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#setPriority(int)"><code>setPriority(int)</code></a>)</dd><dd><code>iteratorClass</code> - the class for the iterator</dd></dl> +</li> +</ul> +<a name="IteratorSetting(int, java.lang.Class, java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IteratorSetting</h4> +<pre>public IteratorSetting(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.accumulo.core.iterators.SortedKeyValueIterator<<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iteratorClass, + <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</pre> +<div class="block">Constructs an iterator setting using the given class's SimpleName for the iterator name and configured for the specified scopes with the specified + parameters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - the priority for the iterator (see <a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#setPriority(int)"><code>setPriority(int)</code></a>)</dd><dd><code>iteratorClass</code> - the class for the iterator</dd><dd><code>properties</code> - any properties for the iterator</dd></dl> +</li> +</ul> +<a name="IteratorSetting(int, java.lang.String, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IteratorSetting</h4> +<pre>public IteratorSetting(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.accumulo.core.iterators.SortedKeyValueIterator<<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iteratorClass)</pre> +<div class="block">Constructs an iterator setting configured for the scan scope with no parameters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - the priority for the iterator (see <a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#setPriority(int)"><code>setPriority(int)</code></a>)</dd><dd><code>name</code> - the distinguishing name for the iterator</dd><dd><code>iteratorClass</code> - the class for the iterator</dd></dl> +</li> +</ul> +<a name="IteratorSetting(int, java.lang.String, java.lang.Class, java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IteratorSetting</h4> +<pre>public IteratorSetting(int priority, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends org.apache.accumulo.core.iterators.SortedKeyValueIterator<<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iteratorClass, + <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</pre> +<div class="block">Constructs an iterator setting using the provided name and the provided class's name for the scan scope with the provided parameters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - The priority for the iterator (see <a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#setPriority(int)"><code>setPriority(int)</code></a>)</dd><dd><code>name</code> - The distinguishing name for the iterator</dd><dd><code>iteratorClass</code> - The class for the iterator</dd><dd><code>properties</code> - Any properties for the iterator</dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</dd></dl> +</li> +</ul> +<a name="IteratorSetting(java.io.DataInput)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IteratorSetting</h4> +<pre>public IteratorSetting(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataInput.html?is-external=true"; title="class or interface in java.io">DataInput</a> din) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</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="getPriority()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPriority</h4> +<pre>public int getPriority()</pre> +<div class="block">Get layer at which this iterator applies. See <a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html#setPriority(int)"><code>setPriority(int)</code></a> for how the priority is used.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the priority of this Iterator</dd></dl> +</li> +</ul> +<a name="setPriority(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPriority</h4> +<pre>public void setPriority(int priority)</pre> +<div class="block">Set layer at which this iterator applies.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - determines the order in which iterators are applied (system iterators are always applied first, then user-configured iterators, lowest priority + first)</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getName()</pre> +<div class="block">Get the iterator's name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the iterator</dd></dl> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Set the iterator's name. Must be a simple alphanumeric identifier.</div> +</li> +</ul> +<a name="getIteratorClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIteratorClass</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getIteratorClass()</pre> +<div class="block">Get the name of the class that implements the iterator.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the iterator's class name</dd></dl> +</li> +</ul> +<a name="setIteratorClass(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIteratorClass</h4> +<pre>public void setIteratorClass(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> iteratorClass)</pre> +<div class="block">Set the name of the class that implements the iterator. The class does not have to be present on the client, but it must be available to all tablet + servers.</div> +</li> +</ul> +<a name="addOption(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOption</h4> +<pre>public void addOption(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> option, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> value)</pre> +<div class="block">Add another option to the iterator.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>option</code> - the name of the option</dd><dd><code>value</code> - the value of the option</dd></dl> +</li> +</ul> +<a name="removeOption(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeOption</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> removeOption(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> option)</pre> +<div class="block">Remove an option from the iterator.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>option</code> - the name of the option</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value previously associated with the option, or null if no such option existed</dd></dl> +</li> +</ul> +<a name="addOptions(java.util.Set)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOptions</h4> +<pre>public void addOptions(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> propertyEntries)</pre> +<div class="block">Add many options to the iterator.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyEntries</code> - a set of entries to add to the options</dd></dl> +</li> +</ul> +<a name="addOptions(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addOptions</h4> +<pre>public void addOptions(<a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> properties)</pre> +<div class="block">Add many options to the iterator.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - a map of entries to add to the options</dd></dl> +</li> +</ul> +<a name="getOptions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOptions</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> getOptions()</pre> +<div class="block">Get the configuration parameters for this iterator.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the properties</dd></dl> +</li> +</ul> +<a name="clearOptions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearOptions</h4> +<pre>public void clearOptions()</pre> +<div class="block">Remove all options from the iterator.</div> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="readFields(java.io.DataInput)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFields</h4> +<pre>public void readFields(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataInput.html?is-external=true"; title="class or interface in java.io">DataInput</a> din) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>readFields</code> in interface <code>org.apache.hadoop.io.Writable</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><code>Writable</code></dd></dl> +</li> +</ul> +<a name="write(java.io.DataOutput)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutput.html?is-external=true"; title="class or interface in java.io">DataOutput</a> dout) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>write</code> in interface <code>org.apache.hadoop.io.Writable</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><code>Writable</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/IteratorSetting.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/IsolatedScanner.RowBufferFactory.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/IteratorSetting.html" target="_top">Frames</a></li> +<li><a href="IteratorSetting.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>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 © 2011–2016 <a href="https://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/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/MultiTableBatchWriter.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/MultiTableBatchWriter.html b/1.8/apidocs/org/apache/accumulo/core/client/MultiTableBatchWriter.html new file mode 100644 index 0000000..db79dbb --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/MultiTableBatchWriter.html @@ -0,0 +1,281 @@ +<!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_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MultiTableBatchWriter (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<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="MultiTableBatchWriter (Apache Accumulo Project 1.8.0 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/MultiTableBatchWriter.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/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/MultiTableBatchWriter.html" target="_top">Frames</a></li> +<li><a href="MultiTableBatchWriter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client</div> +<h2 title="Interface MultiTableBatchWriter" class="title">Interface MultiTableBatchWriter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/accumulo/core/client/mock/MockMultiTableBatchWriter.html" title="class in org.apache.accumulo.core.client.mock">MockMultiTableBatchWriter</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">MultiTableBatchWriter</span></pre> +<div class="block">This class enables efficient batch writing to multiple tables. When creating a batch writer for each table, each has its own memory and network resources. + Using this class these resources may be shared among multiple tables.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.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/MultiTableBatchWriter.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/MultiTableBatchWriter.html#getBatchWriter(java.lang.String)">getBatchWriter</a></strong>(<a href="http://docs.oracle.com/javase/7/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/MultiTableBatchWriter.html#isClosed()">isClosed</a></strong>()</code> +<div class="block">Returns true if this batch writer has been closed.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getBatchWriter(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBatchWriter</h4> +<pre><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/7/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">Returns a BatchWriter for a particular table.</div> +<dl><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>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">Send mutations for all tables to accumulo.</div> +<dl><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>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">Flush and release all resources.</div> +<dl><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>boolean isClosed()</pre> +<div class="block">Returns true if this batch writer has been closed.</div> +<dl><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/MultiTableBatchWriter.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/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/MultiTableBatchWriter.html" target="_top">Frames</a></li> +<li><a href="MultiTableBatchWriter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011–2016 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
