io.cdap.cdap.api.mapreduce

Class AbstractMapReduce

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<MapReduceConfigurer>

io.cdap.cdap.api.mapreduce.AbstractMapReduce

All Implemented Interfaces:

MapReduce, ProgramLifecycle<MapReduceContext>

public abstract class AbstractMapReduce
extends AbstractPluginConfigurable<MapReduceConfigurer>
implements MapReduce, ProgramLifecycle<MapReduceContext>

This abstract class provides a default implementation of MapReduce methods for easy extension.

Constructor Summary

Constructors

Constructor and Description
AbstractMapReduce()

Method Summary

Modifier and Type	Method and Description
protected void	configure() Override this method to configure this MapReduce job.
void	configure(MapReduceConfigurer configurer) Configures a MapReduce job using the given MapReduceConfigurer.
void	destroy() Classes derived from AbstractMapReduce can override this method to destroy the MapReduce.
protected MapReduceConfigurer	getConfigurer() Returns the MapReduceConfigurer, only available at configuration time.
protected MapReduceContext	getContext() Return an instance of the MapReduceContext.
protected void	initialize() Classes derived from AbstractMapReduce can override this method to initialize the MapReduce.
void	initialize(MapReduceContext context) Initializes a Program.
protected void	setDescription(String description) Sets the description of the MapReduce.
protected void	setDriverResources(Resources resources) Sets the resources requirement for the driver of the MapReduce.
protected void	setMapperResources(Resources resources) Sets the resources requirement for Mapper task of the MapReduce.
protected void	setName(String name) Sets the name of the MapReduce.
protected void	setProperties(Map<String,String> properties) Sets a set of properties that will be available through the MapReduceSpecification.getProperties() at runtime.
protected void	setReducerResources(Resources resources) Sets the resources requirement for Reducer task of the MapReduce.

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMapReduce

public AbstractMapReduce()

Method Detail

configure

public final void configure(MapReduceConfigurer configurer)

Description copied from interface: MapReduce

Configures a MapReduce job using the given MapReduceConfigurer.

Specified by:

configure in interface MapReduce

configure

protected void configure()

Override this method to configure this MapReduce job.

getConfigurer

protected final MapReduceConfigurer getConfigurer()

Returns the MapReduceConfigurer, only available at configuration time.

Specified by:

getConfigurer in class AbstractPluginConfigurable<MapReduceConfigurer>

setName

protected final void setName(String name)

Sets the name of the MapReduce.

setDescription

protected final void setDescription(String description)

Sets the description of the MapReduce.

setProperties

protected final void setProperties(Map<String,String> properties)

Sets a set of properties that will be available through the MapReduceSpecification.getProperties() at runtime.

Parameters:

properties - the properties to set

setDriverResources

protected final void setDriverResources(Resources resources)

Sets the resources requirement for the driver of the MapReduce.

setMapperResources

protected final void setMapperResources(Resources resources)

Sets the resources requirement for Mapper task of the MapReduce.

setReducerResources

protected final void setReducerResources(Resources resources)

Sets the resources requirement for Reducer task of the MapReduce.

initialize

public final void initialize(MapReduceContext context)
                      throws Exception

Description copied from interface: ProgramLifecycle

Initializes a Program.

This method will be called only once per ProgramLifecycle instance.

Specified by:

initialize in interface ProgramLifecycle<MapReduceContext>

Parameters:

context - An instance of RuntimeContext

Throws:

Exception - If there is any error during initialization.

initialize

protected void initialize()
                   throws Exception

Classes derived from AbstractMapReduce can override this method to initialize the MapReduce. MapReduceContext will be available in this method using getContext().

Throws:

Exception - if there is any error in initializing the MapReduce

destroy

public void destroy()

Classes derived from AbstractMapReduce can override this method to destroy the MapReduce.

Specified by:

destroy in interface ProgramLifecycle<MapReduceContext>

getContext

protected final MapReduceContext getContext()

Return an instance of the MapReduceContext.