oracle.spatial.hadoop.vector.mapreduce.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

oracle.spatial.hadoop.vector.mapreduce.job.SpatialJoin

public class SpatialJoin
extends SpatialJoin

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(Job)
4. Call configure(Job)
5. Run the job.

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

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
SpatialJoin()

Method Summary

Modifier and Type	Method and Description
void	configure(Job job) Validates and adds the current parameters to the job configuration
static void	main(java.lang.String[] args)
boolean	preprocess(Job job) Checks whether partitioning is required and if so, it runs the partitioning process.
int	run(java.lang.String[] args)

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

getCmdOptions, getCurrentCmdArgs, getOutput, getPartitioningResultPath, getSamplingRatio, getSpatialOperationConfig, processArgs, setPartitioningResultPath, setSamplingRatio, setSpatialOperationConfig

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(Job job)
               throws java.lang.Exception

Description copied from class: BaseJob

Validates and adds the current parameters to the job configuration

Overrides:

configure in class SpatialJoin

Parameters:

job - a job instance

Throws:

java.lang.Exception

main

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

Throws:

java.lang.Exception

preprocess

public boolean preprocess(Job job)
                   throws java.lang.Exception

Description copied from class: SpatialJoin

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

Overrides:

preprocess in class SpatialJoin

Parameters:

job - the job configuration

Returns:

true if there were no errors

Throws:

java.lang.Exception

run

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

Overrides:

run in class SpatialJoin

Throws:

java.lang.Exception