Google Git
Sign in
apache / accumulo-website / 949d7010a2c1ab8ef4c0e3bed1e6a2938a58f06c / . / 1.9 / apidocs / org / apache / accumulo / core / client / mapred / InputFormatBase.html
blob: 4beb780a3751804d8bc4b35b31d8f672b9d92686 [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:12 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InputFormatBase (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="InputFormatBase (Apache Accumulo Project 1.9.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":41,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/InputFormatBase.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/mapred/AccumuloRowInputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/InputFormatBase.html" target="_top">Frames</a></li>
<li><a href="InputFormatBase.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.accumulo.core.client.mapred.AbstractInputFormat">Field</a>&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.mapred</div>
<h2 title="Class InputFormatBase" class="title">Class InputFormatBase&lt;K,V&gt;</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><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">org.apache.accumulo.core.client.mapred.AbstractInputFormat</a>&lt;K,V&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.accumulo.core.client.mapred.InputFormatBase&lt;K,V&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.mapred.InputFormat&lt;K,V&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AccumuloInputFormat</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloRowInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AccumuloRowInputFormat</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">InputFormatBase&lt;K,V&gt;</span>
extends <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a>&lt;K,V&gt;</pre>
<div class="block">This abstract <code>InputFormat</code> class allows MapReduce jobs to use Accumulo as the source of
K,V pairs.
<p>
Subclasses must implement a <code>InputFormat.getRecordReader(InputSplit, JobConf, Reporter)</code> to provide a
<code>RecordReader</code> for K,V.
<p>
A static base class, RecordReaderBase, is provided to retrieve Accumulo <a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data"><code>Key</code></a>/<a href="../../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data"><code>Value</code></a>
pairs, but one must implement its <code>RecordReader.next(Object, Object)</code> to transform them
to the desired generic types K,V.
<p>
See <a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><code>AccumuloInputFormat</code></a> for an example implementation.</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="memberSummary" 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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">InputFormatBase.RangeInputSplit</a></span></code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 1.5.2; Use <a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred"><code>RangeInputSplit</code></a>
instead.</span></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RecordReaderBase.html" title="class in org.apache.accumulo.core.client.mapred">InputFormatBase.RecordReaderBase</a>&lt;<a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RecordReaderBase.html" title="type parameter in InputFormatBase.RecordReaderBase">K</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RecordReaderBase.html" title="type parameter in InputFormatBase.RecordReaderBase">V</a>&gt;</span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.accumulo.core.client.mapred.AbstractInputFormat">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.accumulo.core.client.mapred.<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a></h3>
<code><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat.AbstractRecordReader</a>&lt;<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="type parameter in AbstractInputFormat.AbstractRecordReader">K</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="type parameter in AbstractInputFormat.AbstractRecordReader">V</a>&gt;</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.accumulo.core.client.mapred.AbstractInputFormat">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.accumulo.core.client.mapred.<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a></h3>
<code><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#CLASS">CLASS</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#log">log</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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/mapred/InputFormatBase.html#InputFormatBase--">InputFormatBase</a></span>()</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#addIterator-org.apache.hadoop.mapred.JobConf-org.apache.accumulo.core.client.IteratorSetting-">addIterator</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
<a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a>&nbsp;cfg)</code>
<div class="block">Encode an iterator on the input for this job.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#fetchColumns-org.apache.hadoop.mapred.JobConf-java.util.Collection-">fetchColumns</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
<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;columnFamilyColumnQualifierPairs)</code>
<div class="block">Restricts the columns that will be mapped over for this job.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#getAutoAdjustRanges-org.apache.hadoop.mapred.JobConf-">getAutoAdjustRanges</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Determines whether a configuration has auto-adjust ranges enabled.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</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/mapred/InputFormatBase.html#getFetchedColumns-org.apache.hadoop.mapred.JobConf-">getFetchedColumns</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Gets the columns to be mapped over from this job.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#getInputTableName-org.apache.hadoop.mapred.JobConf-">getInputTableName</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Gets the table name from the configuration.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected static <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/mapred/InputFormatBase.html#getIterators-org.apache.hadoop.mapred.JobConf-">getIterators</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Gets a list of the iterator settings (for iterators to apply to a scanner) from this
configuration.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected static <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/mapred/InputFormatBase.html#getRanges-org.apache.hadoop.mapred.JobConf-">getRanges</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Gets the ranges to scan over from a job.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected static org.apache.accumulo.core.client.impl.TabletLocator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#getTabletLocator-org.apache.hadoop.mapred.JobConf-">getTabletLocator</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">since 1.6.0</span></div>
</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#isBatchScan-org.apache.hadoop.mapred.JobConf-">isBatchScan</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Determines whether a configuration has the <a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><code>BatchScanner</code></a>
feature enabled.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#isIsolated-org.apache.hadoop.mapred.JobConf-">isIsolated</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Determines whether a configuration has isolation enabled.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#isOfflineScan-org.apache.hadoop.mapred.JobConf-">isOfflineScan</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Determines whether a configuration has the offline table scan feature enabled.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setAutoAdjustRanges-org.apache.hadoop.mapred.JobConf-boolean-">setAutoAdjustRanges</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</code>
<div class="block">Controls the automatic adjustment of ranges for this job.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setBatchScan-org.apache.hadoop.mapred.JobConf-boolean-">setBatchScan</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</code>
<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><code>BatchScanner</code></a> in this job.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setInputTableName-org.apache.hadoop.mapred.JobConf-java.lang.String-">setInputTableName</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tableName)</code>
<div class="block">Sets the name of the input table, over which this job will scan.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setLocalIterators-org.apache.hadoop.mapred.JobConf-boolean-">setLocalIterators</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</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="i15" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setOfflineTableScan-org.apache.hadoop.mapred.JobConf-boolean-">setOfflineTableScan</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</code>
<div class="block">Enable reading offline tables.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setRanges-org.apache.hadoop.mapred.JobConf-java.util.Collection-">setRanges</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
<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;<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 this job.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setSamplerConfiguration-org.apache.hadoop.mapred.JobConf-org.apache.accumulo.core.client.sample.SamplerConfiguration-">setSamplerConfiguration</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
<a href="../../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a>&nbsp;samplerConfig)</code>
<div class="block">Causes input format to read sample data.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setScanIsolation-org.apache.hadoop.mapred.JobConf-boolean-">setScanIsolation</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</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="i19" class="rowColor">
<td class="colFirst"><code>protected static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#usesLocalIterators-org.apache.hadoop.mapred.JobConf-">usesLocalIterators</a></span>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code>
<div class="block">Determines whether a configuration uses local iterators.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.accumulo.core.client.mapred.AbstractInputFormat">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.accumulo.core.client.mapred.<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a></h3>
<code><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getAuthenticationToken-org.apache.hadoop.mapred.JobConf-">getAuthenticationToken</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getClassLoaderContext-org.apache.hadoop.mapred.JobConf-">getClassLoaderContext</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getClientConfiguration-org.apache.hadoop.mapred.JobConf-">getClientConfiguration</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInputTableConfig-org.apache.hadoop.mapred.JobConf-java.lang.String-">getInputTableConfig</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInputTableConfigs-org.apache.hadoop.mapred.JobConf-">getInputTableConfigs</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInstance-org.apache.hadoop.mapred.JobConf-">getInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getLogLevel-org.apache.hadoop.mapred.JobConf-">getLogLevel</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getPrincipal-org.apache.hadoop.mapred.JobConf-">getPrincipal</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getScanAuthorizations-org.apache.hadoop.mapred.JobConf-">getScanAuthorizations</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getSplits-org.apache.hadoop.mapred.JobConf-int-">getSplits</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getTabletLocator-org.apache.hadoop.mapred.JobConf-java.lang.String-">getTabletLocator</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#isConnectorInfoSet-org.apache.hadoop.mapred.JobConf-">isConnectorInfoSet</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setClassLoaderContext-org.apache.hadoop.mapred.JobConf-java.lang.String-">setClassLoaderContext</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo-org.apache.hadoop.mapred.JobConf-java.lang.String-org.apache.accumulo.core.client.security.tokens.AuthenticationToken-">setConnectorInfo</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo-org.apache.hadoop.mapred.JobConf-java.lang.String-java.lang.String-">setConnectorInfo</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setLogLevel-org.apache.hadoop.mapred.JobConf-org.apache.log4j.Level-">setLogLevel</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setMockInstance-org.apache.hadoop.mapred.JobConf-java.lang.String-">setMockInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setScanAuthorizations-org.apache.hadoop.mapred.JobConf-org.apache.accumulo.core.security.Authorizations-">setScanAuthorizations</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance-org.apache.hadoop.mapred.JobConf-org.apache.accumulo.core.client.ClientConfiguration-">setZooKeeperInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance-org.apache.hadoop.mapred.JobConf-java.lang.String-java.lang.String-">setZooKeeperInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#validateOptions-org.apache.hadoop.mapred.JobConf-">validateOptions</a></code></li>
</ul>
<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#equals-java.lang.Object-" title="class or interface in java.lang">equals</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#hashCode--" title="class or interface in java.lang">hashCode</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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.mapred.InputFormat">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.hadoop.mapred.InputFormat</h3>
<code>getRecordReader</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="InputFormatBase--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>InputFormatBase</h4>
<pre>public&nbsp;InputFormatBase()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setInputTableName-org.apache.hadoop.mapred.JobConf-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInputTableName</h4>
<pre>public static&nbsp;void&nbsp;setInputTableName(org.apache.hadoop.mapred.JobConf&nbsp;job,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tableName)</pre>
<div class="block">Sets the name of the input table, over which this job will scan.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>tableName</code> - the table to use when the tablename is null in the write call</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
</dl>
</li>
</ul>
<a name="getInputTableName-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputTableName</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getInputTableName(org.apache.hadoop.mapred.JobConf&nbsp;job)</pre>
<div class="block">Gets the table name from the configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the table name</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setInputTableName-org.apache.hadoop.mapred.JobConf-java.lang.String-"><code>setInputTableName(JobConf, String)</code></a></dd>
</dl>
</li>
</ul>
<a name="setRanges-org.apache.hadoop.mapred.JobConf-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRanges</h4>
<pre>public static&nbsp;void&nbsp;setRanges(org.apache.hadoop.mapred.JobConf&nbsp;job,
<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;<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 this job. If not set, the entire table will be scanned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>ranges</code> - the ranges that will be mapped over</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
</dl>
</li>
</ul>
<a name="getRanges-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRanges</h4>
<pre>protected static&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(org.apache.hadoop.mapred.JobConf&nbsp;job)
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">Gets the ranges to scan over from a job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ranges</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> - if the ranges have been encoded improperly</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setRanges-org.apache.hadoop.mapred.JobConf-java.util.Collection-"><code>setRanges(JobConf, Collection)</code></a></dd>
</dl>
</li>
</ul>
<a name="fetchColumns-org.apache.hadoop.mapred.JobConf-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchColumns</h4>
<pre>public static&nbsp;void&nbsp;fetchColumns(org.apache.hadoop.mapred.JobConf&nbsp;job,
<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;columnFamilyColumnQualifierPairs)</pre>
<div class="block">Restricts the columns that will be mapped over for this job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>columnFamilyColumnQualifierPairs</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.5.0</dd>
</dl>
</li>
</ul>
<a name="getFetchedColumns-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFetchedColumns</h4>
<pre>protected static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;org.apache.accumulo.core.util.Pair&lt;org.apache.hadoop.io.Text,org.apache.hadoop.io.Text&gt;&gt;&nbsp;getFetchedColumns(org.apache.hadoop.mapred.JobConf&nbsp;job)</pre>
<div class="block">Gets the columns to be mapped over from this job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set of columns</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#fetchColumns-org.apache.hadoop.mapred.JobConf-java.util.Collection-"><code>fetchColumns(JobConf, Collection)</code></a></dd>
</dl>
</li>
</ul>
<a name="addIterator-org.apache.hadoop.mapred.JobConf-org.apache.accumulo.core.client.IteratorSetting-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addIterator</h4>
<pre>public static&nbsp;void&nbsp;addIterator(org.apache.hadoop.mapred.JobConf&nbsp;job,
<a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a>&nbsp;cfg)</pre>
<div class="block">Encode an iterator on the input for this job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>cfg</code> - the configuration of the iterator</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
</dl>
</li>
</ul>
<a name="getIterators-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIterators</h4>
<pre>protected static&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(org.apache.hadoop.mapred.JobConf&nbsp;job)</pre>
<div class="block">Gets a list of the iterator settings (for iterators to apply to a scanner) from this
configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of iterators</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#addIterator-org.apache.hadoop.mapred.JobConf-org.apache.accumulo.core.client.IteratorSetting-"><code>addIterator(JobConf, IteratorSetting)</code></a></dd>
</dl>
</li>
</ul>
<a name="setAutoAdjustRanges-org.apache.hadoop.mapred.JobConf-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoAdjustRanges</h4>
<pre>public static&nbsp;void&nbsp;setAutoAdjustRanges(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</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>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setRanges-org.apache.hadoop.mapred.JobConf-java.util.Collection-"><code>setRanges(JobConf, Collection)</code></a></dd>
</dl>
</li>
</ul>
<a name="getAutoAdjustRanges-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAutoAdjustRanges</h4>
<pre>protected static&nbsp;boolean&nbsp;getAutoAdjustRanges(org.apache.hadoop.mapred.JobConf&nbsp;job)</pre>
<div class="block">Determines whether a configuration has auto-adjust ranges enabled. Must be enabled when
<a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setBatchScan-org.apache.hadoop.mapred.JobConf-boolean-"><code>setBatchScan(JobConf, boolean)</code></a> is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<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.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setAutoAdjustRanges-org.apache.hadoop.mapred.JobConf-boolean-"><code>setAutoAdjustRanges(JobConf, boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setScanIsolation-org.apache.hadoop.mapred.JobConf-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setScanIsolation</h4>
<pre>public static&nbsp;void&nbsp;setScanIsolation(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</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>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
</dl>
</li>
</ul>
<a name="isIsolated-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIsolated</h4>
<pre>protected static&nbsp;boolean&nbsp;isIsolated(org.apache.hadoop.mapred.JobConf&nbsp;job)</pre>
<div class="block">Determines whether a configuration has isolation enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<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.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setScanIsolation-org.apache.hadoop.mapred.JobConf-boolean-"><code>setScanIsolation(JobConf, boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setLocalIterators-org.apache.hadoop.mapred.JobConf-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalIterators</h4>
<pre>public static&nbsp;void&nbsp;setLocalIterators(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</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>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
</dl>
</li>
</ul>
<a name="usesLocalIterators-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usesLocalIterators</h4>
<pre>protected static&nbsp;boolean&nbsp;usesLocalIterators(org.apache.hadoop.mapred.JobConf&nbsp;job)</pre>
<div class="block">Determines whether a configuration uses local iterators.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<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.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setLocalIterators-org.apache.hadoop.mapred.JobConf-boolean-"><code>setLocalIterators(JobConf, boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setOfflineTableScan-org.apache.hadoop.mapred.JobConf-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOfflineTableScan</h4>
<pre>public static&nbsp;void&nbsp;setOfflineTableScan(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</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.
<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>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</dd>
</dl>
</li>
</ul>
<a name="isOfflineScan-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOfflineScan</h4>
<pre>protected static&nbsp;boolean&nbsp;isOfflineScan(org.apache.hadoop.mapred.JobConf&nbsp;job)</pre>
<div class="block">Determines whether a configuration has the offline table scan feature enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<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.5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setOfflineTableScan-org.apache.hadoop.mapred.JobConf-boolean-"><code>setOfflineTableScan(JobConf, boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setBatchScan-org.apache.hadoop.mapred.JobConf-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBatchScan</h4>
<pre>public static&nbsp;void&nbsp;setBatchScan(org.apache.hadoop.mapred.JobConf&nbsp;job,
boolean&nbsp;enableFeature)</pre>
<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><code>BatchScanner</code></a> in this job. Using
this feature will group Ranges by their source tablet, producing an InputSplit per tablet
rather than per Range. This batching helps to reduce overhead when querying a large number of
small ranges. (ex: when doing quad-tree decomposition for spatial queries)
<p>
In order to achieve good locality of InputSplits this option always clips the input Ranges to
tablet boundaries. This may result in one input Range contributing to several InputSplits.
<p>
Note: that the value of <a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setAutoAdjustRanges-org.apache.hadoop.mapred.JobConf-boolean-"><code>setAutoAdjustRanges(JobConf, boolean)</code></a> is ignored and is
assumed to be true when BatchScan option is enabled.
<p>
This configuration is incompatible with:
<ul>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setOfflineTableScan-org.apache.hadoop.mapred.JobConf-boolean-"><code>setOfflineTableScan(JobConf, boolean)</code></a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setLocalIterators-org.apache.hadoop.mapred.JobConf-boolean-"><code>setLocalIterators(JobConf, boolean)</code></a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setScanIsolation-org.apache.hadoop.mapred.JobConf-boolean-"><code>setScanIsolation(JobConf, boolean)</code></a></li>
</ul>
<p>
By default, this feature is <b>disabled</b>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.0</dd>
</dl>
</li>
</ul>
<a name="isBatchScan-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBatchScan</h4>
<pre>public static&nbsp;boolean&nbsp;isBatchScan(org.apache.hadoop.mapred.JobConf&nbsp;job)</pre>
<div class="block">Determines whether a configuration has the <a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><code>BatchScanner</code></a>
feature enabled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop context for the configured job</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.7.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setBatchScan-org.apache.hadoop.mapred.JobConf-boolean-"><code>setBatchScan(JobConf, boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setSamplerConfiguration-org.apache.hadoop.mapred.JobConf-org.apache.accumulo.core.client.sample.SamplerConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSamplerConfiguration</h4>
<pre>public static&nbsp;void&nbsp;setSamplerConfiguration(org.apache.hadoop.mapred.JobConf&nbsp;job,
<a href="../../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a>&nbsp;samplerConfig)</pre>
<div class="block">Causes input format to read sample data. If sample data was created using a different
configuration or a tables sampler configuration changes while reading data, then the input
format will throw an error.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop job instance to be configured</dd>
<dd><code>samplerConfig</code> - The sampler configuration that sample must have been created with inorder for reading
sample data to succeed.</dd>
<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></dd>
</dl>
</li>
</ul>
<a name="getTabletLocator-org.apache.hadoop.mapred.JobConf-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTabletLocator</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
protected static&nbsp;org.apache.accumulo.core.client.impl.TabletLocator&nbsp;getTabletLocator(org.apache.hadoop.mapred.JobConf&nbsp;job)
throws <a href="../../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.6.0</span></div>
<div class="block">Initializes an Accumulo <code>TabletLocator</code> based on the
configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the Hadoop job for the configured job</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Accumulo tablet locator</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></code> - if the table name set on the job doesn't exist</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.5.0</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/InputFormatBase.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/mapred/AccumuloRowInputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/InputFormatBase.html" target="_top">Frames</a></li>
<li><a href="InputFormatBase.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.accumulo.core.client.mapred.AbstractInputFormat">Field</a>&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>