http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/mapred/InputFormatBase.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/mapred/InputFormatBase.html b/1.8/apidocs/org/apache/accumulo/core/client/mapred/InputFormatBase.html new file mode 100644 index 0000000..842a37d --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/mapred/InputFormatBase.html @@ -0,0 +1,789 @@ +<!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>InputFormatBase (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="InputFormatBase (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/InputFormatBase.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloRowInputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/InputFormatBase.html" target="_top">Frames</a></li> +<li><a href="InputFormatBase.html" target="_top">No 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="#fields_inherited_from_class_org.apache.accumulo.core.client.mapred.AbstractInputFormat">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>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client.mapred</div> +<h2 title="Class InputFormatBase" class="title">Class InputFormatBase<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><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">org.apache.accumulo.core.client.mapred.AbstractInputFormat</a><K,V></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.mapred.InputFormatBase<K,V></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.hadoop.mapred.InputFormat<K,V></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AccumuloInputFormat</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloRowInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AccumuloRowInputFormat</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">InputFormatBase<K,V></span> +extends <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a><K,V></pre> +<div class="block">This abstract <code>InputFormat</code> class allows MapReduce jobs to use Accumulo as the source of K,V pairs. + <p> + Subclasses must implement a <code>InputFormat.getRecordReader(InputSplit, JobConf, Reporter)</code> to provide a <code>RecordReader</code> for K,V. + <p> + A static base class, RecordReaderBase, is provided to retrieve Accumulo <a href="../../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data"><code>Key</code></a>/<a href="../../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data"><code>Value</code></a> pairs, but one must implement its + <code>RecordReader.next(Object, Object)</code> to transform them to the desired generic types K,V. + <p> + See <a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><code>AccumuloInputFormat</code></a> for an example implementation.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">InputFormatBase.RangeInputSplit</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.5.2; Use <a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred"><code>RangeInputSplit</code></a> instead.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RecordReaderBase.html" title="class in org.apache.accumulo.core.client.mapred">InputFormatBase.RecordReaderBase</a><<a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RecordReaderBase.html" title="type parameter in InputFormatBase.RecordReaderBase">K</a>,<a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RecordReaderBase.html" title="type parameter in InputFormatBase.RecordReaderBase">V</a>></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.accumulo.core.client.mapred.AbstractInputFormat"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.accumulo.core.client.mapred.<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a></h3> +<code><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat.AbstractRecordReader</a><<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></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.accumulo.core.client.mapred.AbstractInputFormat"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.accumulo.core.client.mapred.<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a></h3> +<code><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#CLASS">CLASS</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#log">log</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="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/InputFormatBase.html#InputFormatBase()">InputFormatBase</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>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#addIterator(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.IteratorSetting)">addIterator</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a> cfg)</code> +<div class="block">Encode an iterator on the input 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/InputFormatBase.html#fetchColumns(org.apache.hadoop.mapred.JobConf,%20java.util.Collection)">fetchColumns</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> columnFamilyColumnQualifierPairs)</code> +<div class="block">Restricts the columns that will be mapped over for this job.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#getAutoAdjustRanges(org.apache.hadoop.mapred.JobConf)">getAutoAdjustRanges</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Determines whether a configuration has auto-adjust ranges enabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#getFetchedColumns(org.apache.hadoop.mapred.JobConf)">getFetchedColumns</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Gets the columns to be mapped over from this job.</div> +</td> +</tr> +<tr class="altColor"> +<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/InputFormatBase.html#getInputTableName(org.apache.hadoop.mapred.JobConf)">getInputTableName</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Gets the table name from the configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static <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/InputFormatBase.html#getIterators(org.apache.hadoop.mapred.JobConf)">getIterators</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Gets a list of the iterator settings (for iterators to apply to a scanner) from this configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static <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/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#getRanges(org.apache.hadoop.mapred.JobConf)">getRanges</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Gets the ranges to scan over from a job.</div> +</td> +</tr> +<tr class="rowColor"> +<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/InputFormatBase.html#getTabletLocator(org.apache.hadoop.mapred.JobConf)">getTabletLocator</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.6.0</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#isBatchScan(org.apache.hadoop.mapred.JobConf)">isBatchScan</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Determines whether a configuration has the <a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><code>BatchScanner</code></a> feature enabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#isIsolated(org.apache.hadoop.mapred.JobConf)">isIsolated</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Determines whether a configuration has isolation enabled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#isOfflineScan(org.apache.hadoop.mapred.JobConf)">isOfflineScan</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Determines whether a configuration has the offline table scan feature enabled.</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/InputFormatBase.html#setAutoAdjustRanges(org.apache.hadoop.mapred.JobConf,%20boolean)">setAutoAdjustRanges</a></strong>(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</code> +<div class="block">Controls the automatic adjustment of ranges 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/InputFormatBase.html#setBatchScan(org.apache.hadoop.mapred.JobConf,%20boolean)">setBatchScan</a></strong>(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</code> +<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><code>BatchScanner</code></a> in this job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setInputTableName(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">setInputTableName</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">Sets the name of the input table, over which this job will 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/InputFormatBase.html#setLocalIterators(org.apache.hadoop.mapred.JobConf,%20boolean)">setLocalIterators</a></strong>(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</code> +<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client"><code>ClientSideIteratorScanner</code></a> in this job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setOfflineTableScan(org.apache.hadoop.mapred.JobConf,%20boolean)">setOfflineTableScan</a></strong>(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</code> +<div class="block">Enable reading offline tables.</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/InputFormatBase.html#setRanges(org.apache.hadoop.mapred.JobConf,%20java.util.Collection)">setRanges</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> ranges)</code> +<div class="block">Sets the input ranges to scan 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/InputFormatBase.html#setSamplerConfiguration(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.sample.SamplerConfiguration)">setSamplerConfiguration</a></strong>(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a> samplerConfig)</code> +<div class="block">Causes input format to read sample data.</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/InputFormatBase.html#setScanIsolation(org.apache.hadoop.mapred.JobConf,%20boolean)">setScanIsolation</a></strong>(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</code> +<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/IsolatedScanner.html" title="class in org.apache.accumulo.core.client"><code>IsolatedScanner</code></a> in this job.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#usesLocalIterators(org.apache.hadoop.mapred.JobConf)">usesLocalIterators</a></strong>(org.apache.hadoop.mapred.JobConf job)</code> +<div class="block">Determines whether a configuration uses local iterators.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.accumulo.core.client.mapred.AbstractInputFormat"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.accumulo.core.client.mapred.<a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat</a></h3> +<code><a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getAuthenticationToken(org.apache.hadoop.mapred.JobConf)">getAuthenticationToken</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getClassLoaderContext(org.apache.hadoop.mapred.JobConf)">getClassLoaderContext</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getClientConfiguration(org.apache.hadoop.mapred.JobConf)">getClientConfiguration</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInputTableConfig(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">getInputTableConfig</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInputTableConfigs(org.apache.hadoop.mapred.JobConf)">getInputTableConfigs</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getInst ance(org.apache.hadoop.mapred.JobConf)">getInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getLogLevel(org.apache.hadoop.mapred.JobConf)">getLogLevel</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getPrincipal(org.apache.hadoop.mapred.JobConf)">getPrincipal</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getScanAuthorizations(org.apache.hadoop.mapred.JobConf)">getScanAuthorizations</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getSplits(org.apache.hadoop.mapred.JobConf,%20int)">getSplits</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#getTabletLocator(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">getTabletLocator</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#isConnectorInfoSet( org.apache.hadoop.mapred.JobConf)">isConnectorInfoSet</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setClassLoaderContext(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">setClassLoaderContext</a>, <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>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setConnectorInfo(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20java.lang.String)">setConnectorInfo</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setLogLevel(org.apache.hadoop.mapred.JobConf,%20org.apache.log4j.Level)">setLogLevel</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setMockIns tance(org.apache.hadoop.mapred.JobConf,%20java.lang.String)">setMockInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setScanAuthorizations(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.security.Authorizations)">setScanAuthorizations</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.ClientConfiguration)">setZooKeeperInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#setZooKeeperInstance(org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20java.lang.String)">setZooKeeperInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.html#validateOptions(org.apache.hadoop.mapred.JobConf)">validateOptions</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="InputFormatBase()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InputFormatBase</h4> +<pre>public InputFormatBase()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setInputTableName(org.apache.hadoop.mapred.JobConf, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInputTableName</h4> +<pre>public static void setInputTableName(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">Sets the name of the input table, over which this job will scan.</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 to use when the tablename is null in the write call</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getInputTableName(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInputTableName</h4> +<pre>protected static <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> getInputTableName(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Gets the table 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 table 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/InputFormatBase.html#setInputTableName(org.apache.hadoop.mapred.JobConf,%20java.lang.String)"><code>setInputTableName(JobConf, String)</code></a></dd></dl> +</li> +</ul> +<a name="setRanges(org.apache.hadoop.mapred.JobConf, java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRanges</h4> +<pre>public static void setRanges(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> ranges)</pre> +<div class="block">Sets the input ranges to scan for this job. If not set, the entire table will be scanned.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>ranges</code> - the ranges that will be mapped over</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getRanges(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRanges</h4> +<pre>protected static <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/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a>> getRanges(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">Gets the ranges to scan over from a job.</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 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 the ranges have been encoded improperly</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/InputFormatBase.html#setRanges(org.apache.hadoop.mapred.JobConf,%20java.util.Collection)"><code>setRanges(JobConf, Collection)</code></a></dd></dl> +</li> +</ul> +<a name="fetchColumns(org.apache.hadoop.mapred.JobConf, java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchColumns</h4> +<pre>public static void fetchColumns(org.apache.hadoop.mapred.JobConf job, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> columnFamilyColumnQualifierPairs)</pre> +<div class="block">Restricts the columns that will be mapped over 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>columnFamilyColumnQualifierPairs</code> - a pair of <code>Text</code> objects corresponding to column family and column qualifier. If the column qualifier is null, the entire column family is + selected. An empty set is the default and is equivalent to scanning the all columns.</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getFetchedColumns(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFetchedColumns</h4> +<pre>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> getFetchedColumns(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Gets the columns to be mapped over from this job.</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>a set of columns</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/InputFormatBase.html#fetchColumns(org.apache.hadoop.mapred.JobConf,%20java.util.Collection)"><code>fetchColumns(JobConf, Collection)</code></a></dd></dl> +</li> +</ul> +<a name="addIterator(org.apache.hadoop.mapred.JobConf, org.apache.accumulo.core.client.IteratorSetting)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addIterator</h4> +<pre>public static void addIterator(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a> cfg)</pre> +<div class="block">Encode an iterator on the input 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>cfg</code> - the configuration of the iterator</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="getIterators(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIterators</h4> +<pre>protected static <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>> getIterators(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Gets a list of the iterator settings (for iterators to apply to a scanner) from this configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd> +<dt><span class="strong">Returns:</span></dt><dd>a list of iterators</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/InputFormatBase.html#addIterator(org.apache.hadoop.mapred.JobConf,%20org.apache.accumulo.core.client.IteratorSetting)"><code>addIterator(JobConf, IteratorSetting)</code></a></dd></dl> +</li> +</ul> +<a name="setAutoAdjustRanges(org.apache.hadoop.mapred.JobConf, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoAdjustRanges</h4> +<pre>public static void setAutoAdjustRanges(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</pre> +<div class="block">Controls the automatic adjustment of ranges for this job. This feature merges overlapping ranges, then splits them to align with tablet boundaries. + Disabling this feature will cause exactly one Map task to be created for each specified range. The default setting is enabled. * + + <p> + By default, this feature is <b>enabled</b>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd><dt><span class="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/InputFormatBase.html#setRanges(org.apache.hadoop.mapred.JobConf,%20java.util.Collection)"><code>setRanges(JobConf, Collection)</code></a></dd></dl> +</li> +</ul> +<a name="getAutoAdjustRanges(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAutoAdjustRanges</h4> +<pre>protected static boolean getAutoAdjustRanges(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Determines whether a configuration has auto-adjust ranges enabled. Must be enabled when <a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setBatchScan(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setBatchScan(JobConf, boolean)</code></a> is true.</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>false if the feature is disabled, true 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/InputFormatBase.html#setAutoAdjustRanges(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setAutoAdjustRanges(JobConf, boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setScanIsolation(org.apache.hadoop.mapred.JobConf, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setScanIsolation</h4> +<pre>public static void setScanIsolation(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</pre> +<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/IsolatedScanner.html" title="class in org.apache.accumulo.core.client"><code>IsolatedScanner</code></a> in this job. + + <p> + By default, this feature is <b>disabled</b>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="isIsolated(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIsolated</h4> +<pre>protected static boolean isIsolated(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Determines whether a configuration has isolation enabled.</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 feature is enabled, 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/InputFormatBase.html#setScanIsolation(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setScanIsolation(JobConf, boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setLocalIterators(org.apache.hadoop.mapred.JobConf, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLocalIterators</h4> +<pre>public static void setLocalIterators(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</pre> +<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client"><code>ClientSideIteratorScanner</code></a> in this job. Enabling this feature will cause the iterator stack to be constructed within the Map + task, rather than within the Accumulo TServer. To use this feature, all classes needed for those iterators must be available on the classpath for the task. + + <p> + By default, this feature is <b>disabled</b>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="usesLocalIterators(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>usesLocalIterators</h4> +<pre>protected static boolean usesLocalIterators(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Determines whether a configuration uses local iterators.</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 feature is enabled, 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/InputFormatBase.html#setLocalIterators(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setLocalIterators(JobConf, boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setOfflineTableScan(org.apache.hadoop.mapred.JobConf, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOfflineTableScan</h4> +<pre>public static void setOfflineTableScan(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</pre> +<div class="block">Enable reading offline tables. By default, this feature is disabled and only online tables are scanned. This will make the map reduce job directly read the + table's files. If the table is not offline, then the job will fail. If the table comes online during the map reduce job, it is likely that the job will + fail. + + <p> + To use this option, the map reduce user will need access to read the Accumulo directory in HDFS. + + <p> + Reading the offline table will create the scan time iterator stack in the map process. So any iterators that are configured for the table will need to be + on the mapper's classpath. + + <p> + One way to use this feature is to clone a table, take the clone offline, and use the clone as the input table for a map reduce job. If you plan to map + reduce over the data many times, it may be better to the compact the table, clone it, take it offline, and use the clone for all map reduce jobs. The + reason to do this is that compaction will reduce each tablet in the table to one file, and it is faster to read from one file. + + <p> + There are two possible advantages to reading a tables file directly out of HDFS. First, you may see better read performance. Second, it will support + speculative execution better. When reading an online table speculative execution can put more load on an already slow tablet server. + + <p> + By default, this feature is <b>disabled</b>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +<a name="isOfflineScan(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOfflineScan</h4> +<pre>protected static boolean isOfflineScan(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Determines whether a configuration has the offline table scan feature enabled.</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 feature is enabled, 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/InputFormatBase.html#setOfflineTableScan(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setOfflineTableScan(JobConf, boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setBatchScan(org.apache.hadoop.mapred.JobConf, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBatchScan</h4> +<pre>public static void setBatchScan(org.apache.hadoop.mapred.JobConf job, + boolean enableFeature)</pre> +<div class="block">Controls the use of the <a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><code>BatchScanner</code></a> in this job. Using this feature will group Ranges by their source tablet, + producing an InputSplit per tablet rather than per Range. This batching helps to reduce overhead when querying a large number of small ranges. (ex: when + doing quad-tree decomposition for spatial queries) + <p> + In order to achieve good locality of InputSplits this option always clips the input Ranges to tablet boundaries. This may result in one input Range + contributing to several InputSplits. + <p> + Note: that the value of <a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setAutoAdjustRanges(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setAutoAdjustRanges(JobConf, boolean)</code></a> is ignored and is assumed to be true when BatchScan option is enabled. + <p> + This configuration is incompatible with: + <ul> + <li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setOfflineTableScan(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setOfflineTableScan(JobConf, boolean)</code></a></li> + <li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setLocalIterators(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setLocalIterators(JobConf, boolean)</code></a></li> + <li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setScanIsolation(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setScanIsolation(JobConf, boolean)</code></a></li> + </ul> + <p> + By default, this feature is <b>disabled</b>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>enableFeature</code> - the feature is enabled if true, disabled otherwise</dd><dt><span class="strong">Since:</span></dt> + <dd>1.7.0</dd></dl> +</li> +</ul> +<a name="isBatchScan(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBatchScan</h4> +<pre>public static boolean isBatchScan(org.apache.hadoop.mapred.JobConf job)</pre> +<div class="block">Determines whether a configuration has the <a href="../../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client"><code>BatchScanner</code></a> feature enabled.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop context for the configured job</dd><dt><span class="strong">Since:</span></dt> + <dd>1.7.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.html#setBatchScan(org.apache.hadoop.mapred.JobConf,%20boolean)"><code>setBatchScan(JobConf, boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setSamplerConfiguration(org.apache.hadoop.mapred.JobConf, org.apache.accumulo.core.client.sample.SamplerConfiguration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSamplerConfiguration</h4> +<pre>public static void setSamplerConfiguration(org.apache.hadoop.mapred.JobConf job, + <a href="../../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a> samplerConfig)</pre> +<div class="block">Causes input format to read sample data. If sample data was created using a different configuration or a tables sampler configuration changes while reading + data, then the input format will throw an error.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>job</code> - the Hadoop job instance to be configured</dd><dd><code>samplerConfig</code> - The sampler configuration that sample must have been created with inorder for reading sample data to succeed.</dd><dt><span class="strong">Since:</span></dt> + <dd>1.8.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/accumulo/core/client/ScannerBase.html#setSamplerConfiguration(org.apache.accumulo.core.client.sample.SamplerConfiguration)"><code>ScannerBase.setSamplerConfiguration(SamplerConfiguration)</code></a></dd></dl> +</li> +</ul> +<a name="getTabletLocator(org.apache.hadoop.mapred.JobConf)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTabletLocator</h4> +<pre><a href="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) + 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.6.0</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 job 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 job doesn't exist</dd><dt><span class="strong">Since:</span></dt> + <dd>1.5.0</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><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/InputFormatBase.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/AccumuloRowInputFormat.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/InputFormatBase.html" target="_top">Frames</a></li> +<li><a href="InputFormatBase.html" target="_top">No 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="#fields_inherited_from_class_org.apache.accumulo.core.client.mapred.AbstractInputFormat">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>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011–2016 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/mapred/RangeInputSplit.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/mapred/RangeInputSplit.html b/1.8/apidocs/org/apache/accumulo/core/client/mapred/RangeInputSplit.html new file mode 100644 index 0000000..815cd77 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/mapred/RangeInputSplit.html @@ -0,0 +1,315 @@ +<!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>RangeInputSplit (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="RangeInputSplit (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/RangeInputSplit.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/InputFormatBase.RecordReaderBase.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/RangeInputSplit.html" target="_top">Frames</a></li> +<li><a href="RangeInputSplit.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_org.apache.accumulo.core.client.mapreduce.RangeInputSplit">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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 RangeInputSplit" class="title">Class RangeInputSplit</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.hadoop.mapreduce.InputSplit</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapreduce">org.apache.accumulo.core.client.mapreduce.RangeInputSplit</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.mapred.RangeInputSplit</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.hadoop.io.Writable, org.apache.hadoop.mapred.InputSplit</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/accumulo/core/client/mapred/InputFormatBase.RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">InputFormatBase.RangeInputSplit</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RangeInputSplit</span> +extends <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapreduce">RangeInputSplit</a> +implements org.apache.hadoop.mapred.InputSplit</pre> +<div class="block">The Class RangeInputSplit. Encapsulates an Accumulo range for use in Map Reduce jobs.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="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> </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html#RangeInputSplit()">RangeInputSplit</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html#RangeInputSplit(org.apache.accumulo.core.client.mapred.RangeInputSplit)">RangeInputSplit</a></strong>(<a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">RangeInputSplit</a> split)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html#RangeInputSplit(java.lang.String,%20java.lang.String,%20org.apache.accumulo.core.data.Range,%20java.lang.String[])">RangeInputSplit</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> table, + <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, + <a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> range, + <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>[] locations)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.accumulo.core.client.mapreduce.RangeInputSplit"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.accumulo.core.client.mapreduce.<a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapreduce">RangeInputSplit</a></h3> +<code><a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getAuths()">getAuths</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getFetchedColumns()">getFetchedColumns</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getInstance()">getInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getInstance(org.apache.accumulo.core.client.ClientConfiguration)">getInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getInstanceName()">getInstanceName</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getIterators()">getIterators</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getLength()">getLength</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/Range InputSplit.html#getLocations()">getLocations</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getLogLevel()">getLogLevel</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getPrincipal()">getPrincipal</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getProgress(org.apache.accumulo.core.data.ByteSequence,%20org.apache.accumulo.core.data.ByteSequence,%20org.apache.accumulo.core.data.ByteSequence)">getProgress</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getProgress(org.apache.accumulo.core.data.Key)">getProgress</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getRange()">getRange</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getSamplerConfiguration()">getSamplerConfiguration</a>, <a href="../../../../../../o rg/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getTable()">getTable</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getTableId()">getTableId</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getTableName()">getTableName</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getToken()">getToken</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#getZooKeepers()">getZooKeepers</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#isIsolatedScan()">isIsolatedScan</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#isMockInstance()">isMockInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#isOffline()">isOffline</a>, <a href="../../../../../../org/apache/accumulo/co re/client/mapreduce/RangeInputSplit.html#readFields(java.io.DataInput)">readFields</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setAuths(org.apache.accumulo.core.security.Authorizations)">setAuths</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setFetchedColumns(java.util.Collection)">setFetchedColumns</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setFetchedColumns(java.util.Set)">setFetchedColumns</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setInstanceName(java.lang.String)">setInstanceName</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setIsolatedScan(java.lang.Boolean)">setIsolatedScan</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setIterators(java.util.List)">setIterators</a>, <a href="../. ./../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setLocations(java.lang.String[])">setLocations</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setLogLevel(org.apache.log4j.Level)">setLogLevel</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setMockInstance(java.lang.Boolean)">setMockInstance</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setOffline(java.lang.Boolean)">setOffline</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setPrincipal(java.lang.String)">setPrincipal</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setRange(org.apache.accumulo.core.data.Range)">setRange</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setSamplerConfiguration(org.apache.accumulo.core.client.sam ple.SamplerConfiguration)">setSamplerConfiguration</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setTable(java.lang.String)">setTable</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setTableId(java.lang.String)">setTableId</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setTableName(java.lang.String)">setTableName</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setToken(org.apache.accumulo.core.client.security.tokens.AuthenticationToken)">setToken</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setToken(java.lang.String)">setToken</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#setUsesLocalIterators(java.lang.Boolean)">setUsesLocalIterators</a>, <a href="../../../../../../org/apache/accumulo/core/client/ mapreduce/RangeInputSplit.html#setZooKeepers(java.lang.String)">setZooKeepers</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#toString()">toString</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#usesLocalIterators()">usesLocalIterators</a>, <a href="../../../../../../org/apache/accumulo/core/client/mapreduce/RangeInputSplit.html#write(java.io.DataOutput)">write</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.mapreduce.InputSplit"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hadoop.mapreduce.InputSplit</h3> +<code>getLocationInfo</code></li> +</ul> +<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#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.InputSplit"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.mapred.InputSplit</h3> +<code>getLength, getLocations</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.io.Writable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.io.Writable</h3> +<code>readFields, write</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RangeInputSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RangeInputSplit</h4> +<pre>public RangeInputSplit()</pre> +</li> +</ul> +<a name="RangeInputSplit(org.apache.accumulo.core.client.mapred.RangeInputSplit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RangeInputSplit</h4> +<pre>public RangeInputSplit(<a href="../../../../../../org/apache/accumulo/core/client/mapred/RangeInputSplit.html" title="class in org.apache.accumulo.core.client.mapred">RangeInputSplit</a> split) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="RangeInputSplit(java.lang.String, java.lang.String, org.apache.accumulo.core.data.Range, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RangeInputSplit</h4> +<pre>protected RangeInputSplit(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> table, + <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, + <a href="../../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> range, + <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>[] locations)</pre> +</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/RangeInputSplit.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/InputFormatBase.RecordReaderBase.html" title="class in org.apache.accumulo.core.client.mapred"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/accumulo/core/client/mapred/RangeInputSplit.html" target="_top">Frames</a></li> +<li><a href="RangeInputSplit.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_org.apache.accumulo.core.client.mapreduce.RangeInputSplit">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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/class-use/AbstractInputFormat.AbstractRecordReader.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/mapred/class-use/AbstractInputFormat.AbstractRecordReader.html b/1.8/apidocs/org/apache/accumulo/core/client/mapred/class-use/AbstractInputFormat.AbstractRecordReader.html new file mode 100644 index 0000000..88feec5 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/mapred/class-use/AbstractInputFormat.AbstractRecordReader.html @@ -0,0 +1,157 @@ +<!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:23 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Uses of Class org.apache.accumulo.core.client.mapred.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="Uses of Class org.apache.accumulo.core.client.mapred.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><a href="../../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../../overview-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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/accumulo/core/client/mapred/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.accumulo.core.client.mapred.AbstractInputFormat.AbstractRecordReader" class="title">Uses of Class<br>org.apache.accumulo.core.client.mapred.AbstractInputFormat.AbstractRecordReader</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat.AbstractRecordReader</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.accumulo.core.client.mapred">org.apache.accumulo.core.client.mapred</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.accumulo.core.client.mapred"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat.AbstractRecordReader</a> in <a href="../../../../../../../org/apache/accumulo/core/client/mapred/package-summary.html">org.apache.accumulo.core.client.mapred</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred">AbstractInputFormat.AbstractRecordReader</a> in <a href="../../../../../../../org/apache/accumulo/core/client/mapred/package-summary.html">org.apache.accumulo.core.client.mapred</a></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> +<tbody> +<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/InputFormatBase.RecordReaderBase.html" title="class in org.apache.accumulo.core.client.mapred">InputFormatBase.RecordReaderBase</a><K,V></strong></code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../../../org/apache/accumulo/core/client/mapred/AbstractInputFormat.AbstractRecordReader.html" title="class in org.apache.accumulo.core.client.mapred">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../../../../../../../overview-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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/accumulo/core/client/mapred/class-use/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> +<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>