com.twitter.maple.hbase

Class HBaseScheme

java.lang.Object

cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

com.twitter.maple.hbase.HBaseScheme

All Implemented Interfaces:

cascading.util.Traceable, java.io.Serializable

public class HBaseScheme
extends cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

The HBaseScheme class is a Scheme subclass. It is used in conjunction with the HBaseTap to allow for the reading and writing of data to and from a HBase cluster.

See Also:

HBaseTap, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HBaseScheme(cascading.tuple.Fields keyField, cascading.tuple.Fields valueFields) Constructor HBaseScheme creates a new HBaseScheme instance using fully qualified column names
HBaseScheme(cascading.tuple.Fields keyField, cascading.tuple.Fields[] valueFields) Constructor HBaseScheme creates a new HBaseScheme instance using fully qualified column names
HBaseScheme(cascading.tuple.Fields keyFields, java.lang.String[] familyNames, cascading.tuple.Fields[] valueFields) Constructor HBaseScheme creates a new HBaseScheme instance.
HBaseScheme(cascading.tuple.Fields keyFields, java.lang.String familyName, cascading.tuple.Fields valueFields) Constructor HBaseScheme creates a new HBaseScheme instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
java.lang.String[]	getFamilyNames() Method getFamilyNames returns the set of familyNames of this HBaseScheme object.
int	hashCode()
void	sink(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> flowProcess, cascading.scheme.SinkCall<java.lang.Object[],org.apache.hadoop.mapred.OutputCollector> sinkCall)
void	sinkConfInit(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> process, cascading.tap.Tap<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector> tap, org.apache.hadoop.mapred.JobConf conf)
boolean	source(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> flowProcess, cascading.scheme.SourceCall<java.lang.Object[],org.apache.hadoop.mapred.RecordReader> sourceCall)
void	sourceCleanup(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> flowProcess, cascading.scheme.SourceCall<java.lang.Object[],org.apache.hadoop.mapred.RecordReader> sourceCall)
void	sourceConfInit(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> process, cascading.tap.Tap<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector> tap, org.apache.hadoop.mapred.JobConf conf)
void	sourcePrepare(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> flowProcess, cascading.scheme.SourceCall<java.lang.Object[],org.apache.hadoop.mapred.RecordReader> sourceCall)

Methods inherited from class cascading.scheme.Scheme

getNumSinkParts, getSinkFields, getSourceFields, getTrace, isSink, isSource, isSymmetrical, presentSinkFields, presentSinkFieldsInternal, presentSourceFields, presentSourceFieldsInternal, retrieveSinkFields, retrieveSourceFields, setNumSinkParts, setSinkFields, setSourceFields, sinkCleanup, sinkPrepare, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HBaseScheme

public HBaseScheme(cascading.tuple.Fields keyFields,
                   java.lang.String familyName,
                   cascading.tuple.Fields valueFields)

Constructor HBaseScheme creates a new HBaseScheme instance.

Parameters:

keyFields - of type Fields

familyName - of type String

valueFields - of type Fields

HBaseScheme

public HBaseScheme(cascading.tuple.Fields keyFields,
                   java.lang.String[] familyNames,
                   cascading.tuple.Fields[] valueFields)

Constructor HBaseScheme creates a new HBaseScheme instance.

Parameters:

keyFields - of type Fields

familyNames - of type String[]

valueFields - of type Fields[]

HBaseScheme

public HBaseScheme(cascading.tuple.Fields keyField,
                   cascading.tuple.Fields valueFields)

Constructor HBaseScheme creates a new HBaseScheme instance using fully qualified column names

Parameters:

keyField - of type String

valueFields - of type Fields

HBaseScheme

public HBaseScheme(cascading.tuple.Fields keyField,
                   cascading.tuple.Fields[] valueFields)

Constructor HBaseScheme creates a new HBaseScheme instance using fully qualified column names

Parameters:

keyField - of type Field

valueFields - of type Field[]

Method Detail

getFamilyNames

public java.lang.String[] getFamilyNames()

Method getFamilyNames returns the set of familyNames of this HBaseScheme object.

Returns:

the familyNames (type String[]) of this HBaseScheme object.

sourcePrepare

public void sourcePrepare(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> flowProcess,
                          cascading.scheme.SourceCall<java.lang.Object[],org.apache.hadoop.mapred.RecordReader> sourceCall)

Overrides:

sourcePrepare in class cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

sourceCleanup

public void sourceCleanup(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> flowProcess,
                          cascading.scheme.SourceCall<java.lang.Object[],org.apache.hadoop.mapred.RecordReader> sourceCall)

Overrides:

sourceCleanup in class cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

source

public boolean source(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> flowProcess,
                      cascading.scheme.SourceCall<java.lang.Object[],org.apache.hadoop.mapred.RecordReader> sourceCall)
               throws java.io.IOException

Specified by:

source in class cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

Throws:

java.io.IOException

sink

public void sink(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> flowProcess,
                 cascading.scheme.SinkCall<java.lang.Object[],org.apache.hadoop.mapred.OutputCollector> sinkCall)
          throws java.io.IOException

Specified by:

sink in class cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

Throws:

java.io.IOException

sinkConfInit

public void sinkConfInit(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> process,
                         cascading.tap.Tap<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector> tap,
                         org.apache.hadoop.mapred.JobConf conf)

Specified by:

sinkConfInit in class cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

sourceConfInit

public void sourceConfInit(cascading.flow.FlowProcess<org.apache.hadoop.mapred.JobConf> process,
                           cascading.tap.Tap<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector> tap,
                           org.apache.hadoop.mapred.JobConf conf)

Specified by:

sourceConfInit in class cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>

hashCode

public int hashCode()

Overrides:

hashCode in class cascading.scheme.Scheme<org.apache.hadoop.mapred.JobConf,org.apache.hadoop.mapred.RecordReader,org.apache.hadoop.mapred.OutputCollector,java.lang.Object[],java.lang.Object[]>