oracle.spatial.hadoop.vector.mapred.input

Class SpatialIndexInputFormat

java.lang.Object

<any>

oracle.spatial.hadoop.vector.mapred.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 configuration is defined, a SpatialOperation.AnyInteract will be performed taking as query window the boundaries defined in the SpatialConfig (if any).

Author:

hsaucedo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SpatialIndexInputFormat.SpatialIndexRecordReader Reads records from a spatial index split

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_DEFAULT_FILTER_OPERATION Default spatial operation to be performed when there is not a SpatialOperationConfig set.
static java.lang.String	CONF_NON_GEODETIC_FILTER Boolean job configuration value.
static java.lang.String	TAG_SPATIAL_INDEX_SPATIAL_OP_CONFIG Tag used to identify an InputFormat-specific SpatialOperationConfig in a job's configuration.

Constructor Summary

Constructors

Constructor and Description
SpatialIndexInputFormat()

Method Summary

Modifier and Type	Method and Description
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.
<any>	getRecordReader(InputSplit split, JobConf job, Reporter reporter)
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

Field Detail

CONF_DEFAULT_FILTER_OPERATION

public static final java.lang.String CONF_DEFAULT_FILTER_OPERATION

Default spatial operation to be performed when there is not a SpatialOperationConfig set.

See Also:

Constant Field Values

CONF_NON_GEODETIC_FILTER

public static final java.lang.String CONF_NON_GEODETIC_FILTER

Boolean job configuration value. When set to true, forces the filter operation to be non-geodetic despite the srid or the isGeodetic setting.

See Also:

Constant Field Values

TAG_SPATIAL_INDEX_SPATIAL_OP_CONFIG

public static final java.lang.String TAG_SPATIAL_INDEX_SPATIAL_OP_CONFIG

Tag used to identify an InputFormat-specific SpatialOperationConfig in a job's configuration.

See Also:

Constant Field Values

Constructor Detail

SpatialIndexInputFormat

public SpatialIndexInputFormat()

Method Detail

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

getRecordReader

public <any> getRecordReader(InputSplit split,
                             JobConf job,
                             Reporter reporter)
                      throws java.io.IOException

Throws:

java.io.IOException

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