Google Git
Sign in
apache / accumulo-website / 949d7010a2c1ab8ef4c0e3bed1e6a2938a58f06c / . / 1.9 / apidocs / org / apache / accumulo / core / client / mapreduce / InputTableConfig.html
blob: cda99e6219b3eea522323fd401e3c0141490e92c [file] [log] [blame]
<!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 (1.8.0_201) on Thu Apr 11 20:05:13 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InputTableConfig (Apache Accumulo Project 1.9.3 API)</title>
<meta name="date" content="2019-04-11">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="InputTableConfig (Apache Accumulo Project 1.9.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/InputTableConfig.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/mapreduce/InputFormatBase.RecordReaderBase.html" title="class in org.apache.accumulo.core.client.mapreduce"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapreduce"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" target="_top">Frames</a></li>
<li><a href="InputTableConfig.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.mapreduce</div>
<h2 title="Class InputTableConfig" class="title">Class InputTableConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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.mapreduce.InputTableConfig</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="typeNameLabel">InputTableConfig</span>
extends <a href="https://docs.oracle.com/javase/8/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">This class to holds a batch scan configuration for a table. It contains all the properties needed
to specify how rows should be returned from the table.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#InputTableConfig--">InputTableConfig</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#InputTableConfig-java.io.DataInput-">InputTableConfig</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a>&nbsp;input)</code>
<div class="block">Creates a batch scan config object out of a previously serialized batch scan config object.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#fetchColumns-java.util.Collection-">fetchColumns</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;org.apache.accumulo.core.util.Pair&lt;org.apache.hadoop.io.Text,org.apache.hadoop.io.Text&gt;&gt;&nbsp;columns)</code>
<div class="block">Restricts the columns that will be mapped over for this job for the default input table.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;org.apache.accumulo.core.util.Pair&lt;org.apache.hadoop.io.Text,org.apache.hadoop.io.Text&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#getFetchedColumns--">getFetchedColumns</a></span>()</code>
<div class="block">Returns the columns to be fetched for this configuration</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#getIterators--">getIterators</a></span>()</code>
<div class="block">Returns the iterators to be set on this configuration</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#getRanges--">getRanges</a></span>()</code>
<div class="block">Returns the ranges to be queried in the configuration</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#getSamplerConfiguration--">getSamplerConfiguration</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#isOfflineScan--">isOfflineScan</a></span>()</code>
<div class="block">Determines whether a configuration has the offline table scan feature enabled.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#readFields-java.io.DataInput-">readFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a>&nbsp;dataInput)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setAutoAdjustRanges-boolean-">setAutoAdjustRanges</a></span>(boolean&nbsp;autoAdjustRanges)</code>
<div class="block">Controls the automatic adjustment of ranges for this job.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setIterators-java.util.List-">setIterators</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a>&gt;&nbsp;iterators)</code>
<div class="block">Set iterators on to be used in the query.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setOfflineScan-boolean-">setOfflineScan</a></span>(boolean&nbsp;offlineScan)</code>
<div class="block">Enable reading offline tables.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setRanges-java.util.List-">setRanges</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>&gt;&nbsp;ranges)</code>
<div class="block">Sets the input ranges to scan for all tables associated with this job.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setSamplerConfiguration-org.apache.accumulo.core.client.sample.SamplerConfiguration-">setSamplerConfiguration</a></span>(<a href="../../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a>&nbsp;samplerConfiguration)</code>
<div class="block">Set the sampler configuration to use when reading from the data.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setUseIsolatedScanners-boolean-">setUseIsolatedScanners</a></span>(boolean&nbsp;useIsolatedScanners)</code>
<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/IsolatedScanner.html" title="class in org.apache.accumulo.core.client"><code>IsolatedScanner</code></a> in this job.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setUseLocalIterators-boolean-">setUseLocalIterators</a></span>(boolean&nbsp;useLocalIterators)</code>
<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client"><code>ClientSideIteratorScanner</code></a> in
this job.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#shouldAutoAdjustRanges--">shouldAutoAdjustRanges</a></span>()</code>
<div class="block">Determines whether a configuration has auto-adjust ranges enabled.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#shouldUseIsolatedScanners--">shouldUseIsolatedScanners</a></span>()</code>
<div class="block">Determines whether a configuration has isolation enabled.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#shouldUseLocalIterators--">shouldUseLocalIterators</a></span>()</code>
<div class="block">Determines whether a configuration uses local iterators.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#write-java.io.DataOutput-">write</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</a>&nbsp;dataOutput)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" 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="InputTableConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>InputTableConfig</h4>
<pre>public&nbsp;InputTableConfig()</pre>
</li>
</ul>
<a name="InputTableConfig-java.io.DataInput-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>InputTableConfig</h4>
<pre>public&nbsp;InputTableConfig(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a>&nbsp;input)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a batch scan config object out of a previously serialized batch scan config object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - the data input of the serialized batch scan config</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></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="setRanges-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRanges</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>&nbsp;setRanges(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>&gt;&nbsp;ranges)</pre>
<div class="block">Sets the input ranges to scan for all tables associated with this job. This will be added to
any per-table ranges that have been set using</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ranges</code> - the ranges that will be mapped over</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
</dl>
</li>
</ul>
<a name="getRanges--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRanges</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>&gt;&nbsp;getRanges()</pre>
<div class="block">Returns the ranges to be queried in the configuration</div>
</li>
</ul>
<a name="fetchColumns-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchColumns</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>&nbsp;fetchColumns(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;org.apache.accumulo.core.util.Pair&lt;org.apache.hadoop.io.Text,org.apache.hadoop.io.Text&gt;&gt;&nbsp;columns)</pre>
<div class="block">Restricts the columns that will be mapped over for this job for the default input table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columns</code> - a pair of <code>Text</code> objects corresponding to column family and column qualifier. If
the column qualifier is null, the entire column family is selected. An empty set is
the default and is equivalent to scanning the all columns.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
</dl>
</li>
</ul>
<a name="getFetchedColumns--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchedColumns</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;org.apache.accumulo.core.util.Pair&lt;org.apache.hadoop.io.Text,org.apache.hadoop.io.Text&gt;&gt;&nbsp;getFetchedColumns()</pre>
<div class="block">Returns the columns to be fetched for this configuration</div>
</li>
</ul>
<a name="setIterators-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIterators</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>&nbsp;setIterators(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a>&gt;&nbsp;iterators)</pre>
<div class="block">Set iterators on to be used in the query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>iterators</code> - the configurations for the iterators</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
</dl>
</li>
</ul>
<a name="getIterators--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIterators</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a>&gt;&nbsp;getIterators()</pre>
<div class="block">Returns the iterators to be set on this configuration</div>
</li>
</ul>
<a name="setAutoAdjustRanges-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoAdjustRanges</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>&nbsp;setAutoAdjustRanges(boolean&nbsp;autoAdjustRanges)</pre>
<div class="block">Controls the automatic adjustment of ranges for this job. This feature merges overlapping
ranges, then splits them to align with tablet boundaries. Disabling this feature will cause
exactly one Map task to be created for each specified range. The default setting is enabled. *
<p>
By default, this feature is <b>enabled</b>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>autoAdjustRanges</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setRanges-java.util.List-"><code>setRanges(java.util.List)</code></a></dd>
</dl>
</li>
</ul>
<a name="shouldAutoAdjustRanges--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldAutoAdjustRanges</h4>
<pre>public&nbsp;boolean&nbsp;shouldAutoAdjustRanges()</pre>
<div class="block">Determines whether a configuration has auto-adjust ranges enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false if the feature is disabled, true otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setAutoAdjustRanges-boolean-"><code>setAutoAdjustRanges(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setUseLocalIterators-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseLocalIterators</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>&nbsp;setUseLocalIterators(boolean&nbsp;useLocalIterators)</pre>
<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client"><code>ClientSideIteratorScanner</code></a> in
this job. Enabling this feature will cause the iterator stack to be constructed within the Map
task, rather than within the Accumulo TServer. To use this feature, all classes needed for
those iterators must be available on the classpath for the task.
<p>
By default, this feature is <b>disabled</b>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useLocalIterators</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
</dl>
</li>
</ul>
<a name="shouldUseLocalIterators--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldUseLocalIterators</h4>
<pre>public&nbsp;boolean&nbsp;shouldUseLocalIterators()</pre>
<div class="block">Determines whether a configuration uses local iterators.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the feature is enabled, false otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setUseLocalIterators-boolean-"><code>setUseLocalIterators(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setOfflineScan-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOfflineScan</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>&nbsp;setOfflineScan(boolean&nbsp;offlineScan)</pre>
<div class="block">Enable reading offline tables. By default, this feature is disabled and only online tables are
scanned. This will make the map reduce job directly read the table's files. If the table is not
offline, then the job will fail. If the table comes online during the map reduce job, it is
likely that the job will fail.
<p>
To use this option, the map reduce user will need access to read the Accumulo directory in
HDFS.
<p>
Reading the offline table will create the scan time iterator stack in the map process. So any
iterators that are configured for the table will need to be on the mapper's classpath. The
accumulo-site.xml may need to be on the mapper's classpath if HDFS or the Accumulo directory in
HDFS are non-standard.
<p>
One way to use this feature is to clone a table, take the clone offline, and use the clone as
the input table for a map reduce job. If you plan to map reduce over the data many times, it
may be better to the compact the table, clone it, take it offline, and use the clone for all
map reduce jobs. The reason to do this is that compaction will reduce each tablet in the table
to one file, and it is faster to read from one file.
<p>
There are two possible advantages to reading a tables file directly out of HDFS. First, you may
see better read performance. Second, it will support speculative execution better. When reading
an online table speculative execution can put more load on an already slow tablet server.
<p>
By default, this feature is <b>disabled</b>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offlineScan</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
</dl>
</li>
</ul>
<a name="isOfflineScan--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOfflineScan</h4>
<pre>public&nbsp;boolean&nbsp;isOfflineScan()</pre>
<div class="block">Determines whether a configuration has the offline table scan feature enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the feature is enabled, false otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setOfflineScan-boolean-"><code>setOfflineScan(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setUseIsolatedScanners-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseIsolatedScanners</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>&nbsp;setUseIsolatedScanners(boolean&nbsp;useIsolatedScanners)</pre>
<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/IsolatedScanner.html" title="class in org.apache.accumulo.core.client"><code>IsolatedScanner</code></a> in this job.
<p>
By default, this feature is <b>disabled</b>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>useIsolatedScanners</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
</dl>
</li>
</ul>
<a name="shouldUseIsolatedScanners--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldUseIsolatedScanners</h4>
<pre>public&nbsp;boolean&nbsp;shouldUseIsolatedScanners()</pre>
<div class="block">Determines whether a configuration has isolation enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the feature is enabled, false otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html#setUseIsolatedScanners-boolean-"><code>setUseIsolatedScanners(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setSamplerConfiguration-org.apache.accumulo.core.client.sample.SamplerConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSamplerConfiguration</h4>
<pre>public&nbsp;void&nbsp;setSamplerConfiguration(<a href="../../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a>&nbsp;samplerConfiguration)</pre>
<div class="block">Set the sampler configuration to use when reading from the data.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html#setSamplerConfiguration-org.apache.accumulo.core.client.sample.SamplerConfiguration-"><code>ScannerBase.setSamplerConfiguration(SamplerConfiguration)</code></a>,
<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputFormatBase.html#setSamplerConfiguration-org.apache.hadoop.mapreduce.Job-org.apache.accumulo.core.client.sample.SamplerConfiguration-"><code>InputFormatBase.setSamplerConfiguration(org.apache.hadoop.mapreduce.Job,
SamplerConfiguration)</code></a></dd>
</dl>
</li>
</ul>
<a name="getSamplerConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSamplerConfiguration</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a>&nbsp;getSamplerConfiguration()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8.0</dd>
</dl>
</li>
</ul>
<a name="write-java.io.DataOutput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;void&nbsp;write(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</a>&nbsp;dataOutput)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>write</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.io.Writable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="readFields-java.io.DataInput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFields</h4>
<pre>public&nbsp;void&nbsp;readFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a>&nbsp;dataInput)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>readFields</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.io.Writable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/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="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/InputTableConfig.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/mapreduce/InputFormatBase.RecordReaderBase.html" title="class in org.apache.accumulo.core.client.mapreduce"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapreduce"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" target="_top">Frames</a></li>
<li><a href="InputTableConfig.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2011&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>