oracle.spatial.hadoop.vector.mapred.job

Class Partitioning

java.lang.Object

Configured

oracle.spatial.hadoop.vector.mapred.job.BaseJob<java.lang.Object,java.lang.Object>

oracle.spatial.hadoop.vector.mapred.job.MultipleInputsJob

oracle.spatial.hadoop.vector.mapred.job.Partitioning

Direct Known Subclasses:

Partitioning

public class Partitioning
extends MultipleInputsJob

This class can be used to run or configure a job for spatially partitioning one or more data sets.
Partitioning can be performed using only a fraction of the input data size by setting the setSamplingRatio(double) property (by default it is set to 0.1).
The job's output is a partitioning file, a GeoJSON file containing the generated partitions with information such as the partition geometry and number of elements in the partition.

Author:

hsaucedo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARTITION_RESULT_FILE

Constructor Summary

Constructors

Constructor and Description
Partitioning()

Method Summary

Modifier and Type	Method and Description
void	configure(JobConf jobConf) Validates and adds the current parameters to the job 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.
Path	getPartitionsPath()
double	getSamplingRatio() Gets the ratio of the sample size to the input data size
static 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)
boolean	runFullPartitioningProcess(JobConf jobConf) Runs the full partitioning process.
void	setSamplingRatio(double samplingRatio) Sets the ratio of the sample size to the input data size so only a fraction of the whole input data is used for partitioning.

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

addInputDataSet, getInputs, getMultipleInputDataSetsParams, removeInputDataSet, setInputDataSets

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

Field Detail

PARTITION_RESULT_FILE

public static final java.lang.String PARTITION_RESULT_FILE

See Also:

Constant Field Values

Constructor Detail

Partitioning

public Partitioning()

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<java.lang.Object,java.lang.Object>

Parameters:

jobConf - a job instance

Throws:

java.lang.Exception

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<java.lang.Object,java.lang.Object>

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<java.lang.Object,java.lang.Object>

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

getPartitionsPath

public Path getPartitionsPath()

getSamplingRatio

public double getSamplingRatio()

Gets the ratio of the sample size to the input data size

Returns:

main

public static 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 MultipleInputsJob

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

runFullPartitioningProcess

public boolean runFullPartitioningProcess(JobConf jobConf)
                                   throws java.lang.Exception

Runs the full partitioning process. It is not needed to call configure() when calling this method

Parameters:

jobConf -

Returns:

true if the job finished successfully

Throws:

java.lang.Exception

setSamplingRatio

public void setSamplingRatio(double samplingRatio)

Sets the ratio of the sample size to the input data size so only a fraction of the whole input data is used for partitioning.

Parameters:

samplingRatio -