oracle.spatial.hadoop.vector.mapred.job

Class SpatialJoin

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.SpatialJoin

Direct Known Subclasses:

SpatialJoin

public class SpatialJoin
extends MultipleInputsJob

This class can be used to run or configure a job for joining pairs of records from different data sets based on a spatial interaction between records.
A partitioning result file as generated by Partitioning is required to perform the spatial join. A spatial join can be executed as follows:

1. Create a SpatialJoin instance
2. Set the input parameters such as input data sets, output path and optionally a partitioning result file path.
3. Call preprocess(JobConf)
4. Call configure(JobConf)
5. Run the job.

Note that if a partitioning result file path is not set, partitioning is performed when calling preprocess(JobConf).

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
SpatialJoin()

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.
java.lang.String	getOutput() Gets the job output path
Path	getPartitioningResultPath() Sets the location of a previously generated partitioning result file for the input data sets
double	getSamplingRatio() Gets the ratio of the sample size to the input data size used to sample when a partitioning result file is not set
SpatialOperationConfig	getSpatialOperationConfig() Gets the spatial operation configuration used to perform the spatial join
static void	main(java.lang.String[] args)
boolean	preprocess(JobConf jobConf) Checks whether partitioning is required and if so, it runs the partitioning process.
void	processArgs(java.lang.String[] args, Configuration conf) Extracts and validates arguments from the command line
int	run(java.lang.String[] args)
void	setPartitioningResultPath(Path partitioningResultPath) Gets the location of a previously generated partitioning result file for the input data sets
void	setSamplingRatio(double samplingRatio) Sets the ratio of the sample size to the input data size used to sample when a partitioning result file is not set
void	setSpatialOperationConfig(SpatialOperationConfig spatialOperationConfig) Sets the spatial operation configuration used to perform the spatial join

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, 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

SpatialJoin

public SpatialJoin()

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

getOutput

public java.lang.String getOutput()

Description copied from class: BaseJob

Gets the job output path

Overrides:

getOutput in class BaseJob<java.lang.Object,java.lang.Object>

Returns:

a path

getPartitioningResultPath

public Path getPartitioningResultPath()

Sets the location of a previously generated partitioning result file for the input data sets

Returns:

getSamplingRatio

public double getSamplingRatio()

Gets the ratio of the sample size to the input data size used to sample when a partitioning result file is not set

Returns:

getSpatialOperationConfig

public SpatialOperationConfig getSpatialOperationConfig()

Gets the spatial operation configuration used to perform the spatial join

Returns:

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

preprocess

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

Checks whether partitioning is required and if so, it runs the partitioning process.

Parameters:

jobConf - the job configuration

Returns:

true if there were no errors

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

setPartitioningResultPath

public void setPartitioningResultPath(Path partitioningResultPath)

Gets the location of a previously generated partitioning result file for the input data sets

Parameters:

partitioningResultPath -

setSamplingRatio

public void setSamplingRatio(double samplingRatio)

Sets the ratio of the sample size to the input data size used to sample when a partitioning result file is not set

Parameters:

samplingRatio -

setSpatialOperationConfig

public void setSpatialOperationConfig(SpatialOperationConfig spatialOperationConfig)

Sets the spatial operation configuration used to perform the spatial join

Parameters:

spatialOperationConfig -