http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html b/1.8/apidocs/org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html new file mode 100644 index 0000000..e16a72d --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html @@ -0,0 +1,488 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Sep 06 14:11:21 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractInputFormat.AbstractRecordReader (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="AbstractInputFormat.AbstractRecordReader (Apache Accumulo Project 1.8.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractInputFormat.AbstractRecordReader.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/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloFileOutputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" target="_top">Frames</a></li> +<li><a href="AbstractInputFormat.AbstractRecordReader.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client.mapred</div> +<h2 title="Class AbstractInputFormat.AbstractRecordReader" class="title">Class AbstractInputFormat.AbstractRecordReader<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.mapred.AbstractInputFormat.AbstractRecordReader<K,V></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.hadoop.mapred.RecordReader<K,V></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RecordReaderBase.html" title="class in org.apache.accumulo.core.client.mapred">InputFormatBase.RecordReaderBase</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a><<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="type parameter in AbstractInputFormat">K</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="type parameter in AbstractInputFormat">V</a>></dd> +</dl> +<hr> +<br> +<pre>protected abstract static class <span class="strong">AbstractInputFormat.AbstractRecordReader<K,V></span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements org.apache.hadoop.mapred.RecordReader<K,V></pre> +<div class="block">An abstract base class to be used to create <code>RecordReader</code> instances that convert from 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 to the user's K/V types. + + Subclasses must implement <code>RecordReader.next(Object, Object)</code> to update key and value, and also to update the following variables: + <ul> + <li>Key <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#currentKey"><code>currentKey</code></a> (used for progress reporting)</li> + <li>int <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#numKeysRead"><code>numKeysRead</code></a> (used for progress reporting)</li> + </ul></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#currentKey">currentKey</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#numKeysRead">numKeysRead</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#scannerBase">scannerBase</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#scannerIterator">scannerIterator</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">RangeInputSplit</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#split">split</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#AbstractInputFormat.AbstractRecordReader()">AbstractInputFormat.AbstractRecordReader</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#getPos()">getPos</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#getProgress()">getProgress</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#initialize(org.apache.hadoop.mapred.InputSplit,%20org.apache.hadoop.mapred.JobConf)">initialize</a></strong>(org.apache.hadoop.mapred.InputSplit inSplit, + org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Initialize a scanner over the given input split using this task attempt configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#jobIterators(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">jobIterators</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableName)</code> +<div class="block">Extracts Iterators settings from the context to be used by RecordReader.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#setupIterators(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.Scanner,%20java.lang.String,%20org.apache.accumulo.core.client.mapred.RangeInputSplit)">setupIterators</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableName, + <a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">RangeInputSplit</a> split)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.7.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#jobIterators(org.apache.hadoop.mapred.JobConf,%20java.lang.String)"><code>jobIterators(org.apache.hadoop.mapred.JobConf, java.lang.String)</code></a> instead.</i></div> +</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.mapred.RecordReader"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.mapred.RecordReader</h3> +<code>createKey, createValue, next</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="numKeysRead"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>numKeysRead</h4> +<pre>protected long numKeysRead</pre> +</li> +</ul> +<a name="scannerIterator"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scannerIterator</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> scannerIterator</pre> +</li> +</ul> +<a name="split"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>split</h4> +<pre>protected <a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">RangeInputSplit</a> split</pre> +</li> +</ul> +<a name="scannerBase"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scannerBase</h4> +<pre>protected <a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a> scannerBase</pre> +</li> +</ul> +<a name="currentKey"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>currentKey</h4> +<pre>protected <a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a> currentKey</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractInputFormat.AbstractRecordReader()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractInputFormat.AbstractRecordReader</h4> +<pre>protected AbstractInputFormat.AbstractRecordReader()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="jobIterators(org.apache.hadoop.mapred.JobConf, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>jobIterators</h4> +<pre>protected abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a>> jobIterators(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableName)</pre> +<div class="block">Extracts Iterators settings from the context to be used by RecordReader.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job configuration</dd><dd><code>tableName</code> - the table name for which the scanner is configured</dd> +<dt><span class="strong">Returns:</span></dt><dd>List of iterator settings for given table</dd><dt><span class="strong">Since:</span></dt> + <dd>1.7.0</dd></dl> +</li> +</ul> +<a name="setupIterators(org.apache.hadoop.mapred.JobConf, org.apache.accumulo.core.client.Scanner, java.lang.String, org.apache.accumulo.core.client.mapred.RangeInputSplit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setupIterators</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +protected void setupIterators(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableName, + <a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">RangeInputSplit</a> split)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>since 1.7.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html#jobIterators(org.apache.hadoop.mapred.JobConf,%20java.lang.String)"><code>jobIterators(org.apache.hadoop.mapred.JobConf, java.lang.String)</code></a> instead.</i></div> +<div class="block">Configures the iterators on a scanner for the given table name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job configuration</dd><dd><code>scanner</code> - the scanner for which to configure the iterators</dd><dd><code>tableName</code> - the table name for which the scanner is configured</dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</dd></dl> +</li> +</ul> +<a name="initialize(org.apache.hadoop.mapred.InputSplit, org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public void initialize(org.apache.hadoop.mapred.InputSplit inSplit, + org.apache.hadoop.mapred.JobConf job) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Initialize a scanner over the given input split using this task attempt configuration.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>org.apache.hadoop.mapred.RecordReader<<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>></code></dd> +</dl> +</li> +</ul> +<a name="getPos()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPos</h4> +<pre>public long getPos() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getPos</code> in interface <code>org.apache.hadoop.mapred.RecordReader<<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>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="getProgress()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getProgress</h4> +<pre>public float getProgress() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getProgress</code> in interface <code>org.apache.hadoop.mapred.RecordReader<<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>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractInputFormat.AbstractRecordReader.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/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloFileOutputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" target="_top">Frames</a></li> +<li><a href="AbstractInputFormat.AbstractRecordReader.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011–2016 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/mapred/AbstractInputFormat.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/mapred/AbstractInputFormat.html b/1.8/apidocs/org/apache/accumulo/core/client/mapred/AbstractInputFormat.html new file mode 100644 index 0000000..731ec96 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/mapred/AbstractInputFormat.html @@ -0,0 +1,801 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Sep 06 14:11:21 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractInputFormat (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="AbstractInputFormat (Apache Accumulo Project 1.8.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractInputFormat.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>Prev Class</li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" target="_top">Frames</a></li> +<li><a href="AbstractInputFormat.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client.mapred</div> +<h2 title="Class AbstractInputFormat" class="title">Class AbstractInputFormat<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.mapred.AbstractInputFormat<K,V></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<K,V></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloMultiTableInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AccumuloMultiTableInputFormat</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html" title="class in org.apache.accumulo.core.client.mapred">InputFormatBase</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractInputFormat<K,V></span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements org.apache.hadoop.mapred.InputFormat<K,V></pre> +<div class="block">An abstract input format to provide shared methods common to all other input format classes. At the very least, any classes inheriting from this class will + need to define their own <code>RecordReader</code>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat.AbstractRecordReader</a><<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>></strong></code> +<div class="block">An abstract base class to be used to create <code>RecordReader</code> instances that convert from 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 to the user's K/V types.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#CLASS">CLASS</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static org.apache.log4j.Logger</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#log">log</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#AbstractInputFormat()">AbstractInputFormat</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getAuthenticationToken(org.apache.hadoop.mapred.JobConf)">getAuthenticationToken</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Gets the authenticated token from either the specified token file or directly from the configuration, whichever was used when the job was configured.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getClassLoaderContext(org.apache.hadoop.mapred.JobConf)">getClassLoaderContext</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Returns the name of the current classloader context set on this scanner</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getClientConfiguration(org.apache.hadoop.mapred.JobConf)">getClientConfiguration</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Fetch the client configuration from the job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInputTableConfig(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">getInputTableConfig</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableName)</code> +<div class="block">Fetches a <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a> that has been set on the configuration for a specific table.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInputTableConfigs(org.apache.hadoop.mapred.JobConf)">getInputTableConfigs</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Fetches all <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a>s that have been set on the given Hadoop job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static <a href="../../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInstance(org.apache.hadoop.mapred.JobConf)">getInstance</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Initializes an Accumulo <a href="../../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client"><code>Instance</code></a> based on the configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static org.apache.log4j.Level</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getLogLevel(org.apache.hadoop.mapred.JobConf)">getLogLevel</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Gets the log level from this configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getPrincipal(org.apache.hadoop.mapred.JobConf)">getPrincipal</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Gets the user name from the configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getScanAuthorizations(org.apache.hadoop.mapred.JobConf)">getScanAuthorizations</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Gets the authorizations to set for the scans from the configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.mapred.InputSplit[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getSplits(org.apache.hadoop.mapred.JobConf,%20int)">getSplits</a></strong>(org.apache.hadoop.mapred.JobConf job, + int numSplits)</code> +<div class="block">Gets the splits of the tables that have been set on the job by reading the metadata table for the specified ranges.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static org.apache.accumulo.core.client.impl.TabletLocator</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getTabletLocator(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">getTabletLocator</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableId)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.7.0 This method returns a type that is not part of the public API and is not guaranteed to be stable. The method was deprecated to + discourage its use.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#isConnectorInfoSet(org.apache.hadoop.mapred.JobConf)">isConnectorInfoSet</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Determines if the connector has been configured.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setClassLoaderContext(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">setClassLoaderContext</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> context)</code> +<div class="block">Sets the name of the classloader context on this scanner</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20org.apache.accumulo.core.client.security.tokens.AuthenticationToken)">setConnectorInfo</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> principal, + <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a> token)</code> +<div class="block">Sets the connector information needed to communicate with Accumulo in this job.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20java.lang.String)">setConnectorInfo</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> principal, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tokenFile)</code> +<div class="block">Sets the connector information needed to communicate with Accumulo in this job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setLogLevel(org.apache.hadoop.mapred.JobConf,%20org.apache.log4j.Level)">setLogLevel</a></strong>(org.apache.hadoop.mapred.JobConf job, + org.apache.log4j.Level level)</code> +<div class="block">Sets the log level for this job.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setMockInstance(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">setMockInstance</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> instanceName)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.8.0; use MiniAccumuloCluster or a standard mock framework</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setScanAuthorizations(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.security.Authorizations)">setScanAuthorizations</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> auths)</code> +<div class="block">Sets the <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security"><code>Authorizations</code></a> used to scan.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.ClientConfiguration)">setZooKeeperInstance</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a> clientConfig)</code> +<div class="block">Configures a <a href="../../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html" title="class in org.apache.accumulo.core.client"><code>ZooKeeperInstance</code></a> for this job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20java.lang.String)">setZooKeeperInstance</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> instanceName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> zooKeepers)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.6.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.ClientConfiguration)"><code>setZooKeeperInstance(JobConf, ClientConfiguration)</code></a> instead.</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#validateOptions(org.apache.hadoop.mapred.JobConf)">validateOptions</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Check whether a configuration is fully configured to be used with an Accumulo <code>InputFormat</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.mapred.InputFormat"> +<!-- --> +</a> +<h3>Methods inherited from interface 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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="CLASS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLASS</h4> +<pre>protected static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> CLASS</pre> +</li> +</ul> +<a name="log"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>log</h4> +<pre>protected static final org.apache.log4j.Logger log</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractInputFormat()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractInputFormat</h4> +<pre>public AbstractInputFormat()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setClassLoaderContext(org.apache.hadoop.mapred.JobConf, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClassLoaderContext</h4> +<pre>public static void setClassLoaderContext(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> context)</pre> +<div class="block">Sets the name of the classloader context on this scanner</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>context</code> - name of the classloader context</dd><dt><span class="strong">Since:</span></dt> + <dd>1.8.0</dd></dl> +</li> +</ul> +<a name="getClassLoaderContext(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClassLoaderContext</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getClassLoaderContext(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Returns the name of the current classloader context set on this scanner</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd> +<dt><span class="strong">Returns:</span></dt><dd>name of the current context</dd><dt><span class="strong">Since:</span></dt> + <dd>1.8.0</dd></dl> +</li> +</ul> +<a name="setConnectorInfo(org.apache.hadoop.mapred.JobConf, java.lang.String, org.apache.accumulo.core.client.security.tokens.AuthenticationToken)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConnectorInfo</h4> +<pre>public static void setConnectorInfo(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> principal, + <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a> token) + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block">Sets the connector information needed to communicate with Accumulo in this job. + + <p> + <b>WARNING:</b> Some tokens, when serialized, divulge sensitive information in the configuration as a means to pass the token to MapReduce tasks. This + information is BASE64 encoded to provide a charset safe conversion to a string, but this conversion is not intended to be secure. <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/PasswordToken.html" title="class in org.apache.accumulo.core.client.security.tokens"><code>PasswordToken</code></a> is + one example that is insecure in this way; however <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/DelegationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens"><code>DelegationToken</code></a>s, acquired using + <a href="../../../../../../org/apache/accumulo/core/client/admin/SecurityOperations.html#getDelegationToken(org.apache.accumulo.core.client.admin.DelegationTokenConfig)"><code>SecurityOperations.getDelegationToken(DelegationTokenConfig)</code></a>, is not subject to this concern.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>principal</code> - a valid Accumulo user name (user must have Table.CREATE permission)</dd><dd><code>token</code> - the user's password</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="setConnectorInfo(org.apache.hadoop.mapred.JobConf, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConnectorInfo</h4> +<pre>public static void setConnectorInfo(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> principal, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tokenFile) + throws <a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block">Sets the connector information needed to communicate with Accumulo in this job. + + <p> + Stores the password in a file in HDFS and pulls that into the Distributed Cache in an attempt to be more secure than storing it in the Configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>principal</code> - a valid Accumulo user name (user must have Table.CREATE permission)</dd><dd><code>tokenFile</code> - the path to the token file</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</dd></dl> +</li> +</ul> +<a name="isConnectorInfoSet(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isConnectorInfoSet</h4> +<pre>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> isConnectorInfoSet(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Determines if the connector has been configured.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the connector has been configured, false otherwise</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20org.apache.accumulo.core.client.security.tokens.AuthenticationToken)"><code>setConnectorInfo(JobConf, String, AuthenticationToken)</code></a></dd></dl> +</li> +</ul> +<a name="getPrincipal(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrincipal</h4> +<pre>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getPrincipal(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Gets the user name from the configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Returns:</span></dt><dd>the user name</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20org.apache.accumulo.core.client.security.tokens.AuthenticationToken)"><code>setConnectorInfo(JobConf, String, AuthenticationToken)</code></a></dd></dl> +</li> +</ul> +<a name="getAuthenticationToken(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAuthenticationToken</h4> +<pre>protected static <a href="../../../../../../org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html" title="interface in org.apache.accumulo.core.client.security.tokens">AuthenticationToken</a> getAuthenticationToken(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Gets the authenticated token from either the specified token file or directly from the configuration, whichever was used when the job was configured.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Returns:</span></dt><dd>the principal's authentication token</dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20org.apache.accumulo.core.client.security.tokens.AuthenticationToken)"><code>setConnectorInfo(JobConf, String, AuthenticationToken)</code></a>, +<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20java.lang.String)"><code>setConnectorInfo(JobConf, String, String)</code></a></dd></dl> +</li> +</ul> +<a name="setZooKeeperInstance(org.apache.hadoop.mapred.JobConf, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setZooKeeperInstance</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public static void setZooKeeperInstance(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> instanceName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> zooKeepers)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>since 1.6.0; Use <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.ClientConfiguration)"><code>setZooKeeperInstance(JobConf, ClientConfiguration)</code></a> instead.</i></div> +<div class="block">Configures a <a href="../../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html" title="class in org.apache.accumulo.core.client"><code>ZooKeeperInstance</code></a> for this job.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>instanceName</code> - the Accumulo instance name</dd><dd><code>zooKeepers</code> - a comma-separated list of zookeeper servers</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="setZooKeeperInstance(org.apache.hadoop.mapred.JobConf, org.apache.accumulo.core.client.ClientConfiguration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setZooKeeperInstance</h4> +<pre>public static void setZooKeeperInstance(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a> clientConfig)</pre> +<div class="block">Configures a <a href="../../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html" title="class in org.apache.accumulo.core.client"><code>ZooKeeperInstance</code></a> for this job.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>clientConfig</code> - client configuration containing connection options</dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</dd></dl> +</li> +</ul> +<a name="setMockInstance(org.apache.hadoop.mapred.JobConf, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMockInstance</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public static void setMockInstance(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> instanceName)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>since 1.8.0; use MiniAccumuloCluster or a standard mock framework</i></div> +<div class="block">Configures a <a href="../../../../../../org/apache/accumulo/core/client/mock/MockInstance.html" title="class in org.apache.accumulo.core.client.mock"><code>MockInstance</code></a> for this job.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>instanceName</code> - the Accumulo instance name</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getInstance(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstance</h4> +<pre>protected static <a href="../../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a> getInstance(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Initializes an Accumulo <a href="../../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client"><code>Instance</code></a> based on the configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Returns:</span></dt><dd>an Accumulo instance</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.ClientConfiguration)"><code>setZooKeeperInstance(JobConf, ClientConfiguration)</code></a></dd></dl> +</li> +</ul> +<a name="setLogLevel(org.apache.hadoop.mapred.JobConf, org.apache.log4j.Level)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogLevel</h4> +<pre>public static void setLogLevel(org.apache.hadoop.mapred.JobConf job, + org.apache.log4j.Level level)</pre> +<div class="block">Sets the log level for this job.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>level</code> - the logging level</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getLogLevel(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogLevel</h4> +<pre>protected static org.apache.log4j.Level getLogLevel(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Gets the log level from this configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Returns:</span></dt><dd>the log level</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setLogLevel(org.apache.hadoop.mapred.JobConf,%20org.apache.log4j.Level)"><code>setLogLevel(JobConf, Level)</code></a></dd></dl> +</li> +</ul> +<a name="setScanAuthorizations(org.apache.hadoop.mapred.JobConf, org.apache.accumulo.core.security.Authorizations)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setScanAuthorizations</h4> +<pre>public static void setScanAuthorizations(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> auths)</pre> +<div class="block">Sets the <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security"><code>Authorizations</code></a> used to scan. Must be a subset of the user's authorization. Defaults to the empty set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>auths</code> - the user's authorizations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getScanAuthorizations(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getScanAuthorizations</h4> +<pre>protected static <a href="../../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> getScanAuthorizations(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Gets the authorizations to set for the scans from the configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Returns:</span></dt><dd>the Accumulo scan authorizations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setScanAuthorizations(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.security.Authorizations)"><code>setScanAuthorizations(JobConf, Authorizations)</code></a></dd></dl> +</li> +</ul> +<a name="getTabletLocator(org.apache.hadoop.mapred.JobConf, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTabletLocator</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +protected static org.apache.accumulo.core.client.impl.TabletLocator getTabletLocator(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableId) + 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="strong">Deprecated.</span> <i>since 1.7.0 This method returns a type that is not part of the public API and is not guaranteed to be stable. The method was deprecated to + discourage its use.</i></div> +<div class="block">Initializes an Accumulo <code>TabletLocator</code> based on the configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Returns:</span></dt><dd>an Accumulo tablet locator</dd> +<dt><span class="strong">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 configuration doesn't exist</dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</dd></dl> +</li> +</ul> +<a name="getClientConfiguration(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClientConfiguration</h4> +<pre>protected static <a href="../../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a> getClientConfiguration(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Fetch the client configuration from the job.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - The job</dd> +<dt><span class="strong">Returns:</span></dt><dd>The client configuration for the job</dd><dt><span class="strong">Since:</span></dt> + <dd>1.7.0</dd></dl> +</li> +</ul> +<a name="validateOptions(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validateOptions</h4> +<pre>protected static void validateOptions(org.apache.hadoop.mapred.JobConf job) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Check whether a configuration is fully configured to be used with an Accumulo <code>InputFormat</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if the context is improperly configured</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getInputTableConfigs(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInputTableConfigs</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a>> getInputTableConfigs(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Fetches all <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a>s that have been set on the given Hadoop job.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd> +<dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a> objects set on the job</dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</dd></dl> +</li> +</ul> +<a name="getInputTableConfig(org.apache.hadoop.mapred.JobConf, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInputTableConfig</h4> +<pre>public static <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce">InputTableConfig</a> getInputTableConfig(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> tableName)</pre> +<div class="block">Fetches a <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a> that has been set on the configuration for a specific table. + + <p> + null is returned in the event that the table doesn't exist.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>tableName</code> - the table name for which to grab the config object</dd> +<dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/InputTableConfig.html" title="class in org.apache.accumulo.core.client.mapreduce"><code>InputTableConfig</code></a> for the given table</dd><dt><span class="strong">Since:</span></dt> + <dd>1.6.0</dd></dl> +</li> +</ul> +<a name="getSplits(org.apache.hadoop.mapred.JobConf, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSplits</h4> +<pre>public org.apache.hadoop.mapred.InputSplit[] getSplits(org.apache.hadoop.mapred.JobConf job, + int numSplits) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Gets the splits of the tables that have been set on the job by reading the metadata table for the specified ranges.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getSplits</code> in interface <code>org.apache.hadoop.mapred.InputFormat<<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="type parameter in AbstractInputFormat">K</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="type parameter in AbstractInputFormat">V</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the splits from the tables based on the ranges.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if a table set on the job doesn't exist or an error occurs initializing the tablet locator</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractInputFormat.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>Prev Class</li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" target="_top">Frames</a></li> +<li><a href="AbstractInputFormat.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011–2016 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
