oracle.spatial.hadoop.vector.mapred.job

Class Binning<K,V>

java.lang.Object

org.apache.hadoop.conf.Configured

oracle.spatial.hadoop.vector.mapred.job.BaseJob<K,V>

oracle.spatial.hadoop.vector.mapred.job.IndexedInputBaseJob<K,V>

oracle.spatial.hadoop.vector.mapred.job.Binning<K,V>

Type Parameters:

K - the type of the input keys

V - the type of the input values

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

Direct Known Subclasses:

Binning

public class Binning<K,V>
extends IndexedInputBaseJob<K,V>

This class can be used to run or configure a job for performing spatial binning. Records of the input dataset will be mapped to cells (bins) of a grid.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ARG_AGGR_FIELDS
protected static java.lang.String	ARG_CELL_SHAPE
protected static java.lang.String	ARG_CELL_SIZE
protected static java.lang.String	ARG_GRID_MBR
protected BinningConfig	binConf
protected static java.lang.String	RESULT_FILE_NAME

Fields inherited from class oracle.spatial.hadoop.vector.mapred.job.BaseJob

argsp, inputDataSet, jarClass, jobRegEntryPath, proxyIDS

Constructor Summary

Constructors

Constructor and Description
Binning()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.apache.hadoop.mapred.JobConf jobConf) Validates and adds the current parameters to the job configuration
BinningConfig	getBinConf() Gets the binning configuration
java.lang.String	getCmdOptions() Gets a description of the arguments expected from command line.
java.util.Map<java.lang.String,java.lang.Object>	getCurrentCmdArgs(org.apache.hadoop.conf.Configuration conf) Returns the current driver properties in a map where each key-value is a name and value of a command line argument.
protected InputDataSetCmdArgsParserHandler	getInputDataSetCmdParserHandler(org.apache.hadoop.conf.Configuration conf) Gets the current instance of InputDataSetCmdArgsParserHandler used to parse command line parameters for the input data set
protected InputDataSetConfiguratorHandler	getInputDataSetConfiguratorHandler(org.apache.hadoop.conf.Configuration conf) Returns the current instance of InputDataSetConfiguratorHandler used to configure the input data set
static <K,V> void	main(java.lang.String[] args)
void	processArgs(java.lang.String[] args, org.apache.hadoop.conf.Configuration conf) Extracts and validates arguments from the command line
int	run(java.lang.String[] args)
void	setBinConf(BinningConfig binConf) Sets the binning configuration

Methods inherited from class oracle.spatial.hadoop.vector.mapred.job.IndexedInputBaseJob

getIndexMetadataDir, getIndexName, getProxyIDS, isInputIndex, setIndexMetadataDir, setIndexName, setInputIndex, updateInputDataSet

Methods inherited from class oracle.spatial.hadoop.vector.mapred.job.BaseJob

addJobRegistryEntry, addJobRegistryEntry, addJobRegistryEntry, configure, createJob, createJob, createJob, createJob, createJobConf, createJobConf, createJobConf, getCmdOptionsWithInputDataSets, getCmdOptionsWithInputDataSets, getCurrentCmdArgsAsString, getCurrentCmdArgsAsString, getInput, getInputDataSet, getInputFormatClass, getJarClass, getOutput, getRecordInfoProviderClass, getSpatialConfig, runJob, runJob, setInput, setInputDataSet, setInputFormatClass, setJarClass, setOutput, setRecordInfoProviderClass, setSpatialConfig

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Field Detail

ARG_CELL_SIZE

protected static final java.lang.String ARG_CELL_SIZE

See Also:

Constant Field Values

ARG_GRID_MBR

protected static final java.lang.String ARG_GRID_MBR

See Also:

Constant Field Values

ARG_AGGR_FIELDS

protected static final java.lang.String ARG_AGGR_FIELDS

See Also:

Constant Field Values

ARG_CELL_SHAPE

protected static final java.lang.String ARG_CELL_SHAPE

See Also:

Constant Field Values

RESULT_FILE_NAME

protected static final java.lang.String RESULT_FILE_NAME

See Also:

Constant Field Values

binConf

protected BinningConfig binConf

Constructor Detail

Binning

public Binning()

Method Detail

getInputDataSetConfiguratorHandler

protected InputDataSetConfiguratorHandler getInputDataSetConfiguratorHandler(org.apache.hadoop.conf.Configuration conf)

Description copied from class: BaseJob

Returns the current instance of InputDataSetConfiguratorHandler used to configure the input data set

Specified by:

getInputDataSetConfiguratorHandler in class BaseJob<K,V>

Parameters:

conf - a job configuration

Returns:

an instance of InputDataSetConfiguratorHandler

getInputDataSetCmdParserHandler

protected InputDataSetCmdArgsParserHandler getInputDataSetCmdParserHandler(org.apache.hadoop.conf.Configuration conf)

Description copied from class: BaseJob

Gets the current instance of InputDataSetCmdArgsParserHandler used to parse command line parameters for the input data set

Specified by:

getInputDataSetCmdParserHandler in class BaseJob<K,V>

Parameters:

conf - a job configuration

Returns:

an instance of InputDataSetCmdArgsParserHandler

getBinConf

public BinningConfig getBinConf()

Gets the binning configuration

Returns:

a binning configuration

setBinConf

public void setBinConf(BinningConfig binConf)

Sets the binning configuration

Parameters:

binConf - a binning configuration

processArgs

public void processArgs(java.lang.String[] args,
                        org.apache.hadoop.conf.Configuration conf)
                 throws java.lang.Exception

Description copied from class: BaseJob

Extracts and validates arguments from the command line

Overrides:

processArgs in class BaseJob<K,V>

Parameters:

args - arguments from the command line

conf - the job configuration

Throws:

java.lang.Exception

getCurrentCmdArgs

public java.util.Map<java.lang.String,java.lang.Object> getCurrentCmdArgs(org.apache.hadoop.conf.Configuration conf)

Description copied from class: BaseJob

Returns the current driver properties in a map where each key-value is a name and value of a command line argument. By printing this information it is possible to know how to execute a similar job from command line

Overrides:

getCurrentCmdArgs in class BaseJob<K,V>

Parameters:

conf - a job configuration

Returns:

a map which entries are of type <String,String> or <String, Map<String, Object>> for multiple input data sets. For nested maps, the entry types are the same than the enclosing map

getCmdOptions

public java.lang.String getCmdOptions()

Description copied from class: BaseJob

Gets a description of the arguments expected from command line.

Overrides:

getCmdOptions in class BaseJob<K,V>

Returns:

a text description

configure

public void configure(org.apache.hadoop.mapred.JobConf jobConf)
               throws java.lang.Exception

Description copied from class: BaseJob

Validates and adds the current parameters to the job configuration

Overrides:

configure in class BaseJob<K,V>

Parameters:

jobConf - the job configuration

Throws:

java.lang.Exception

run

public int run(java.lang.String[] args)
        throws java.lang.Exception

Throws:

java.lang.Exception

main

public static <K,V> void main(java.lang.String[] args)
                       throws java.lang.Exception

Throws:

java.lang.Exception