org.apache.hadoop.hbase.mapred

Class TableInputFormatBase

java.lang.Object

org.apache.hadoop.hbase.mapred.TableInputFormatBase

All Implemented Interfaces:

org.apache.hadoop.mapred.InputFormat<ImmutableBytesWritable,Result>

Direct Known Subclasses:

TableInputFormat

Deprecated.

@Deprecated
@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class TableInputFormatBase
extends Object
implements org.apache.hadoop.mapred.InputFormat<ImmutableBytesWritable,Result>

A Base for TableInputFormats. Receives a HTable, a byte[] of input columns and optionally a Filter. Subclasses may use other TableRecordReader implementations.

An example of a subclass:

   class ExampleTIF extends TableInputFormatBase implements JobConfigurable {

     public void configure(JobConf job) {
       HTable exampleTable = new HTable(HBaseConfiguration.create(job),
         Bytes.toBytes("exampleTable"));
       // mandatory
       setHTable(exampleTable);
       Text[] inputColumns = new byte [][] { Bytes.toBytes("columnA"),
         Bytes.toBytes("columnB") };
       // mandatory
       setInputColumns(inputColumns);
       RowFilterInterface exampleFilter = new RegExpRowFilter("keyPrefix.*");
       // optional
       setRowFilter(exampleFilter);
     }

     public void validateInput(JobConf job) throws IOException {
     }
  }
 

Constructor Summary

Constructors

Constructor and Description
TableInputFormatBase() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
protected HTable	getHTable() Deprecated. Allows subclasses to get the HTable.
org.apache.hadoop.mapred.RecordReader<ImmutableBytesWritable,Result>	getRecordReader(org.apache.hadoop.mapred.InputSplit split, org.apache.hadoop.mapred.JobConf job, org.apache.hadoop.mapred.Reporter reporter) Deprecated. Builds a TableRecordReader.
org.apache.hadoop.mapred.InputSplit[]	getSplits(org.apache.hadoop.mapred.JobConf job, int numSplits) Deprecated. Calculates the splits that will serve as input for the map tasks.
protected void	setHTable(HTable table) Deprecated. Allows subclasses to set the HTable.
protected void	setInputColumns(byte[][] inputColumns) Deprecated.
protected void	setRowFilter(Filter rowFilter) Deprecated. Allows subclasses to set the Filter to be used.
protected void	setTableRecordReader(TableRecordReader tableRecordReader) Deprecated. Allows subclasses to set the TableRecordReader.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableInputFormatBase

public TableInputFormatBase()

Deprecated.

Method Detail

getRecordReader

public org.apache.hadoop.mapred.RecordReader<ImmutableBytesWritable,Result> getRecordReader(org.apache.hadoop.mapred.InputSplit split,
                                                                                   org.apache.hadoop.mapred.JobConf job,
                                                                                   org.apache.hadoop.mapred.Reporter reporter)
                                                                                     throws IOException

Deprecated.

Builds a TableRecordReader. If no TableRecordReader was provided, uses the default.

Specified by:

getRecordReader in interface org.apache.hadoop.mapred.InputFormat<ImmutableBytesWritable,Result>

Throws:

IOException

See Also:

InputFormat.getRecordReader(InputSplit, JobConf, Reporter)

getSplits

public org.apache.hadoop.mapred.InputSplit[] getSplits(org.apache.hadoop.mapred.JobConf job,
                                              int numSplits)
                                                throws IOException

Deprecated.

Calculates the splits that will serve as input for the map tasks.

Splits are created in number equal to the smallest between numSplits and the number of HRegions in the table. If the number of splits is smaller than the number of HRegions then splits are spanned across multiple HRegions and are grouped the most evenly possible. In the case splits are uneven the bigger splits are placed first in the InputSplit array.

Specified by:

getSplits in interface org.apache.hadoop.mapred.InputFormat<ImmutableBytesWritable,Result>

Parameters:

job - the map task JobConf

numSplits - a hint to calculate the number of splits (mapred.map.tasks).

Returns:

the input splits

Throws:

IOException

See Also:

InputFormat.getSplits(org.apache.hadoop.mapred.JobConf, int)

setInputColumns

protected void setInputColumns(byte[][] inputColumns)

Deprecated.

Parameters:

inputColumns - to be passed in Result to the map task.

getHTable

protected HTable getHTable()

Deprecated.

Allows subclasses to get the HTable.

setHTable

protected void setHTable(HTable table)

Deprecated.

Allows subclasses to set the HTable.

Parameters:

table - to get the data from

setTableRecordReader

protected void setTableRecordReader(TableRecordReader tableRecordReader)

Deprecated.

Allows subclasses to set the TableRecordReader.

Parameters:

tableRecordReader - to provide other TableRecordReader implementations.

setRowFilter

protected void setRowFilter(Filter rowFilter)

Deprecated.

Allows subclasses to set the Filter to be used.

Parameters:

rowFilter -