oracle.spatial.hadoop.vector.mapred.job

Class Binning<K,V>

java.lang.Object

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

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.

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
Binning()

Method Summary

Modifier and Type	Method and Description
void	configure(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(Configuration conf) Returns the current driver properties in a map where each key-value is a name and value of a command line argument.
static <K,V> void	main(java.lang.String[] args)
void	processArgs(java.lang.String[] args, 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, isInputIndex, setIndexMetadataDir, setIndexName, setInputIndex

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

getCmdOptionsWithInputDataSets, getCurrentCmdArgsAsString, getInput, getInputDataSet, getInputFormatClass, getJarClass, getOutput, getRecordInfoProviderClass, getSpatialConfig, setInput, setInputDataSet, setInputFormatClass, setJarClass, setOutput, setRecordInfoProviderClass, setSpatialConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

Binning

public Binning()

Method Detail

configure

public void configure(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 - a job instance

Throws:

java.lang.Exception

getBinConf

public BinningConfig getBinConf()

Gets the binning configuration

Returns:

a binning configuration

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

getCurrentCmdArgs

public java.util.Map<java.lang.String,java.lang.Object> getCurrentCmdArgs(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

main

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

Throws:

java.lang.Exception

processArgs

public void processArgs(java.lang.String[] args,
                        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

run

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

Throws:

java.lang.Exception

setBinConf

public void setBinConf(BinningConfig binConf)

Sets the binning configuration

Parameters:

binConf - a binning configuration