devapidocs/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html - hbase-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>TableInputFormatBase (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.hadoop.hbase.mapred, class: TableInputFormatBase">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/TableInputFormatBase.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#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">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="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.mapred</a></div>
 <h1 title="Class TableInputFormatBase" class="title">Class TableInputFormatBase</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.hadoop.hbase.mapred.TableInputFormatBase</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code>org.apache.hadoop.mapred.InputFormat&lt;<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;</code></dd>
 </dl>
 <dl class="notes">
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="TableInputFormat.html" title="class in org.apache.hadoop.hbase.mapred">TableInputFormat</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="annotations">@Public
 </span><span class="modifiers">public abstract class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-76">TableInputFormatBase</a></span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 implements org.apache.hadoop.mapred.InputFormat&lt;<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;</span></div>
 <div class="block">A Base for <a href="TableInputFormat.html" title="class in org.apache.hadoop.hbase.mapred"><code>TableInputFormat</code></a>s. Receives a <a href="../client/Table.html" title="interface in org.apache.hadoop.hbase.client"><code>Table</code></a>, a byte[] of input columns and
  optionally a <a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>. Subclasses may use other TableRecordReader implementations.
  <p/>
  Subclasses MUST ensure initializeTable(Connection, TableName) is called for an instance to
  function properly. Each of the entry points to this class used by the MapReduce framework,
  <a href="#getRecordReader(org.apache.hadoop.mapred.InputSplit,org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.Reporter)"><code>getRecordReader(InputSplit, JobConf, Reporter)</code></a> and <a href="#getSplits(org.apache.hadoop.mapred.JobConf,int)"><code>getSplits(JobConf, int)</code></a>,
  will call <a href="#initialize(org.apache.hadoop.mapred.JobConf)"><code>initialize(JobConf)</code></a> as a convenient centralized location to handle retrieving
  the necessary configuration information. If your subclass overrides either of these methods,
  either call the parent version or call initialize yourself.
  <p>
  An example of a subclass:

  <pre>
    class ExampleTIF extends TableInputFormatBase {

      @Override
      protected void initialize(JobConf context) throws IOException {
        // We are responsible for the lifecycle of this connection until we hand it over in
        // initializeTable.
        Connection connection =
           ConnectionFactory.createConnection(HBaseConfiguration.create(job));
        TableName tableName = TableName.valueOf("exampleTable");
        // mandatory. once passed here, TableInputFormatBase will handle closing the connection.
        initializeTable(connection, tableName);
        byte[][] inputColumns = new byte [][] { Bytes.toBytes("columnA"),
          Bytes.toBytes("columnB") };
        // mandatory
        setInputColumns(inputColumns);
        // optional, by default we'll get everything for the given columns.
        Filter exampleFilter = new RowFilter(CompareOp.EQUAL, new RegexStringComparator("aa.*"));
        setRowFilter(exampleFilter);
      }
    }
  </pre></div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>private <a href="../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></div>
 <div class="col-second even-row-color"><code><a href="#connection" class="member-name-link">connection</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#INITIALIZATION_ERROR" class="member-name-link">INITIALIZATION_ERROR</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private byte[][]</code></div>
 <div class="col-second even-row-color"><code><a href="#inputColumns" class="member-name-link">inputColumns</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private static final org.slf4j.Logger</code></div>
 <div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color"><code><a href="#NOT_INITIALIZED" class="member-name-link">NOT_INITIALIZED</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private <a href="../client/RegionLocator.html" title="interface in org.apache.hadoop.hbase.client">RegionLocator</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#regionLocator" class="member-name-link">regionLocator</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private <a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></div>
 <div class="col-second even-row-color"><code><a href="#rowFilter" class="member-name-link">rowFilter</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private <a href="../client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#table" class="member-name-link">table</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private <a href="TableRecordReader.html" title="class in org.apache.hadoop.hbase.mapred">TableRecordReader</a></code></div>
 <div class="col-second even-row-color"><code><a href="#tableRecordReader" class="member-name-link">tableRecordReader</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">TableInputFormatBase</a>()</code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close(java.io.Closeable...)" class="member-name-link">close</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a>...&nbsp;closables)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#closeTable()" class="member-name-link">closeTable</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Close the Table and related objects that were initialized via
  <a href="#initializeTable(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.TableName)"><code>initializeTable(Connection, TableName)</code></a>.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.mapred.RecordReader&lt;<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRecordReader(org.apache.hadoop.mapred.InputSplit,org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.Reporter)" class="member-name-link">getRecordReader</a><wbr>(org.apache.hadoop.mapred.InputSplit&nbsp;split,
  org.apache.hadoop.mapred.JobConf&nbsp;job,
  org.apache.hadoop.mapred.Reporter&nbsp;reporter)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Builds a TableRecordReader.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.mapred.InputSplit[]</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSplits(org.apache.hadoop.mapred.JobConf,int)" class="member-name-link">getSplits</a><wbr>(org.apache.hadoop.mapred.JobConf&nbsp;job,
  int&nbsp;numSplits)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Calculates the splits that will serve as input for the map tasks.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTable()" class="member-name-link">getTable</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Allows subclasses to get the <a href="../client/Table.html" title="interface in org.apache.hadoop.hbase.client"><code>Table</code></a>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize(org.apache.hadoop.mapred.JobConf)" class="member-name-link">initialize</a><wbr>(org.apache.hadoop.mapred.JobConf&nbsp;job)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Handle subclass specific set up.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initializeTable(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.TableName)" class="member-name-link">initializeTable</a><wbr>(<a href="../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a>&nbsp;connection,
  <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Allows subclasses to initialize the table information.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInputColumns(byte%5B%5D%5B%5D)" class="member-name-link">setInputColumns</a><wbr>(byte[][]&nbsp;inputColumns)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRowFilter(org.apache.hadoop.hbase.filter.Filter)" class="member-name-link">setRowFilter</a><wbr>(<a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>&nbsp;rowFilter)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Allows subclasses to set the <a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a> to be used.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTableRecordReader(org.apache.hadoop.hbase.mapred.TableRecordReader)" class="member-name-link">setTableRecordReader</a><wbr>(<a href="TableRecordReader.html" title="class in org.apache.hadoop.hbase.mapred">TableRecordReader</a>&nbsp;tableRecordReader)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Allows subclasses to set the <a href="TableRecordReader.html" title="class in org.apache.hadoop.hbase.mapred"><code>TableRecordReader</code></a>.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="LOG">
 <h3>LOG</h3>
 <div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type">org.slf4j.Logger</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-78">LOG</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="inputColumns">
 <h3>inputColumns</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">byte[][]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-79">inputColumns</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="table">
 <h3>table</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-80">table</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="regionLocator">
 <h3>regionLocator</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../client/RegionLocator.html" title="interface in org.apache.hadoop.hbase.client">RegionLocator</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-81">regionLocator</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="connection">
 <h3>connection</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-82">connection</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="tableRecordReader">
 <h3>tableRecordReader</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="TableRecordReader.html" title="class in org.apache.hadoop.hbase.mapred">TableRecordReader</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-83">tableRecordReader</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="rowFilter">
 <h3>rowFilter</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-84">rowFilter</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="NOT_INITIALIZED">
 <h3>NOT_INITIALIZED</h3>
 <div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-86">NOT_INITIALIZED</a></span></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapred.TableInputFormatBase.NOT_INITIALIZED">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="INITIALIZATION_ERROR">
 <h3>INITIALIZATION_ERROR</h3>
 <div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-89">INITIALIZATION_ERROR</a></span></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.mapred.TableInputFormatBase.INITIALIZATION_ERROR">Constant Field Values</a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>TableInputFormatBase</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-77">TableInputFormatBase</a></span>()</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="getRecordReader(org.apache.hadoop.mapred.InputSplit,org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.Reporter)">
 <h3>getRecordReader</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.hadoop.mapred.RecordReader&lt;<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-97">getRecordReader</a></span><wbr><span class="parameters">(org.apache.hadoop.mapred.InputSplit&nbsp;split,
  org.apache.hadoop.mapred.JobConf&nbsp;job,
  org.apache.hadoop.mapred.Reporter&nbsp;reporter)</span>
                                                                                      throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block">Builds a TableRecordReader. If no TableRecordReader was provided, uses the default.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code>getRecordReader</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.mapred.InputFormat&lt;<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;</code></dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><code>InputFormat.getRecordReader(InputSplit, JobConf, Reporter)</code></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSplits(org.apache.hadoop.mapred.JobConf,int)">
 <h3>getSplits</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.hadoop.mapred.InputSplit[]</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-172">getSplits</a></span><wbr><span class="parameters">(org.apache.hadoop.mapred.JobConf&nbsp;job,
  int&nbsp;numSplits)</span>
                                                 throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block">Calculates the splits that will serve as input for the map tasks.
  <p/>
  Splits are created in number equal to the smallest between numSplits and the number of
  <a href="../regionserver/HRegion.html" title="class in org.apache.hadoop.hbase.regionserver"><code>HRegion</code></a>s in the table. If the number of splits is
  smaller than the number of <a href="../regionserver/HRegion.html" title="class in org.apache.hadoop.hbase.regionserver"><code>HRegion</code></a>s then splits
  are spanned across multiple <a href="../regionserver/HRegion.html" title="class in org.apache.hadoop.hbase.regionserver"><code>HRegion</code></a>s and are
  grouped the most evenly possible. In the case splits are uneven the bigger splits are placed
  first in the <code>InputSplit</code> array.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code>getSplits</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.mapred.InputFormat&lt;<a href="../io/ImmutableBytesWritable.html" title="class in org.apache.hadoop.hbase.io">ImmutableBytesWritable</a>,<wbr><a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>&gt;</code></dd>
 <dt>Parameters:</dt>
 <dd><code>job</code> - the map task <code>JobConf</code></dd>
 <dd><code>numSplits</code> - a hint to calculate the number of splits (mapred.map.tasks).</dd>
 <dt>Returns:</dt>
 <dd>the input splits</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><code>InputFormat.getSplits(org.apache.hadoop.mapred.JobConf, int)</code></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="initializeTable(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.TableName)">
 <h3>initializeTable</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-215">initializeTable</a></span><wbr><span class="parameters">(<a href="../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a>&nbsp;connection,
  <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</span>
                         throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block">Allows subclasses to initialize the table information.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>connection</code> - The Connection to the HBase cluster. MUST be unmanaged. We will close.</dd>
 <dd><code>tableName</code> - The <a href="../TableName.html" title="class in org.apache.hadoop.hbase"><code>TableName</code></a> of the table to process.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setInputColumns(byte[][])">
 <h3>setInputColumns</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-228">setInputColumns</a></span><wbr><span class="parameters">(byte[][]&nbsp;inputColumns)</span></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>inputColumns</code> - to be passed in <a href="../client/Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a> to the map task.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getTable()">
 <h3>getTable</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-235">getTable</a></span>()</div>
 <div class="block">Allows subclasses to get the <a href="../client/Table.html" title="interface in org.apache.hadoop.hbase.client"><code>Table</code></a>.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setTableRecordReader(org.apache.hadoop.hbase.mapred.TableRecordReader)">
 <h3>setTableRecordReader</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-246">setTableRecordReader</a></span><wbr><span class="parameters">(<a href="TableRecordReader.html" title="class in org.apache.hadoop.hbase.mapred">TableRecordReader</a>&nbsp;tableRecordReader)</span></div>
 <div class="block">Allows subclasses to set the <a href="TableRecordReader.html" title="class in org.apache.hadoop.hbase.mapred"><code>TableRecordReader</code></a>. to provide other
  <a href="TableRecordReader.html" title="class in org.apache.hadoop.hbase.mapred"><code>TableRecordReader</code></a> implementations.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setRowFilter(org.apache.hadoop.hbase.filter.Filter)">
 <h3>setRowFilter</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-253">setRowFilter</a></span><wbr><span class="parameters">(<a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>&nbsp;rowFilter)</span></div>
 <div class="block">Allows subclasses to set the <a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a> to be used.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="initialize(org.apache.hadoop.mapred.JobConf)">
 <h3>initialize</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-270">initialize</a></span><wbr><span class="parameters">(org.apache.hadoop.mapred.JobConf&nbsp;job)</span>
                    throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block">Handle subclass specific set up. Each of the entry points used by the MapReduce framework,
  <a href="#getRecordReader(org.apache.hadoop.mapred.InputSplit,org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.Reporter)"><code>getRecordReader(InputSplit, JobConf, Reporter)</code></a> and <a href="#getSplits(org.apache.hadoop.mapred.JobConf,int)"><code>getSplits(JobConf, int)</code></a>,
  will call <a href="#initialize(org.apache.hadoop.mapred.JobConf)"><code>initialize(JobConf)</code></a> as a convenient centralized location to handle
  retrieving the necessary configuration information and calling
  <a href="#initializeTable(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.TableName)"><code>initializeTable(Connection, TableName)</code></a>.
  <p/>
  Subclasses should implement their initialize call such that it is safe to call multiple times.
  The current TableInputFormatBase implementation relies on a non-null table reference to decide
  if an initialize call is needed, but this behavior may change in the future. In particular, it
  is critical that initializeTable not be called multiple times since this will leak Connection
  instances.</div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="closeTable()">
 <h3>closeTable</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-277">closeTable</a></span>()
                    throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block">Close the Table and related objects that were initialized via
  <a href="#initializeTable(org.apache.hadoop.hbase.client.Connection,org.apache.hadoop.hbase.TableName)"><code>initializeTable(Connection, TableName)</code></a>.</div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="close(java.io.Closeable...)">
 <h3>close</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/mapred/TableInputFormatBase.html#line-283">close</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a>...&nbsp;closables)</span>
             throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>