oracle.spatial.hadoop.vector.mapreduce.input

Class SpatialIndexInputFormat

java.lang.Object

<any>

oracle.spatial.hadoop.vector.mapreduce.input.SpatialIndexInputFormat

public class SpatialIndexInputFormat
extends <any>

InputFormat for reading a Spatial Index generated with the Vector API.
This class delivers the records stored into the index as Text/RecordInfo key/value pairs instead of returning the whole RTreeWritable value.
Additionally, a spatial filter can be performed over the input data set; to do that, it is needed to specify a SpatialOperationConfig.
If required, an InputFormat-specific SpatialOperationConfig can be configured to be used only by this InputFormat by calling setFilterSpatialOperationConfig(SpatialOperationConfig, Configuration).
If no spatial operation configuration is defined, a SpatialOperation.AnyInteract will be performed taking as query window the boundaries defined in the SpatialConfig (if any).

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
SpatialIndexInputFormat()

Method Summary

Modifier and Type	Method and Description
<any>	createRecordReader(InputSplit split, TaskAttemptContext context)
static SpatialOperationConfig	getFilterSpatialOperationConfig(Configuration conf) Gets the SpatialOperationConfig used to filter records for the given job's configuration.
static SpatialOperationConfig	getFilterSpatialOperationConfig(java.lang.Integer dataSetId, Configuration conf) Gets the SpatialOperationConfig used to filter records for the given job's configuration and data set.
static void	setFilterSpatialOperationConfig(SpatialOperationConfig spatialOpConf, Configuration conf) Sets an input-format specific SpatialOperationConfig.
static void	setFilterSpatialOperationConfig(SpatialOperationConfig spatialOpConf, java.lang.Integer dataSetId, Configuration conf) Sets an input-format-dataset specific SpatialOperationConfig.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialIndexInputFormat

public SpatialIndexInputFormat()

Method Detail

createRecordReader

public <any> createRecordReader(InputSplit split,
                                TaskAttemptContext context)
                         throws java.io.IOException

Throws:

java.io.IOException

getFilterSpatialOperationConfig

public static SpatialOperationConfig getFilterSpatialOperationConfig(Configuration conf)

Gets the SpatialOperationConfig used to filter records for the given job's configuration.

Parameters:

conf - the job configuration.

Returns:

a SpatialOperationConfig instance

getFilterSpatialOperationConfig

public static SpatialOperationConfig getFilterSpatialOperationConfig(java.lang.Integer dataSetId,
                                                                     Configuration conf)

Gets the SpatialOperationConfig used to filter records for the given job's configuration and data set.

Parameters:

dataSetId - the data set id as assigned by MultipleInputsConfig

conf - the job configuration

Returns:

a SpatialOperationConfig instance

setFilterSpatialOperationConfig

public static void setFilterSpatialOperationConfig(SpatialOperationConfig spatialOpConf,
                                                   Configuration conf)

Sets an input-format specific SpatialOperationConfig.

Parameters:

spatialOpConf - a spatial operation configuration defining how the data should be spatially filtered.

conf - the job's configuration.

setFilterSpatialOperationConfig

public static void setFilterSpatialOperationConfig(SpatialOperationConfig spatialOpConf,
                                                   java.lang.Integer dataSetId,
                                                   Configuration conf)

Sets an input-format-dataset specific SpatialOperationConfig. Used when there are multiple input data sets that use SpatialIndexInputFormat with different filter requirements.

Parameters:

spatialOpConf - a spatial operation configuration defining how the data should be spatially filtered.

dataSetId - the data set id as assigned by MultipleInputsConfig

conf - the job's configuration