oracle.spatial.hadoop.vector.mapred.input

Class SpatialIndexInputFormat

java.lang.Object

org.apache.hadoop.mapred.FileInputFormat<K,V>

org.apache.hadoop.mapred.SequenceFileInputFormat<org.apache.hadoop.io.Text,RecordInfo>

oracle.spatial.hadoop.vector.mapred.input.SpatialIndexInputFormat

All Implemented Interfaces:

org.apache.hadoop.mapred.InputFormat<org.apache.hadoop.io.Text,RecordInfo>

public class SpatialIndexInputFormat
extends org.apache.hadoop.mapred.SequenceFileInputFormat<org.apache.hadoop.io.Text,RecordInfo>

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

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.
protected static java.lang.String[]	SPATIAL_OP_LU_CHAIN
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

Methods

Modifier and Type	Method and Description
static SpatialOperationConfig	getFilterSpatialOperationConfig(org.apache.hadoop.conf.Configuration conf) Gets the SpatialOperationConfig used to filter records for the given job's configuration.
static SpatialOperationConfig	getFilterSpatialOperationConfig(java.lang.Integer dataSetId, org.apache.hadoop.conf.Configuration conf) Gets the SpatialOperationConfig used to filter records for the given job's configuration and data set.
org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.Text,RecordInfo>	getRecordReader(org.apache.hadoop.mapred.InputSplit split, org.apache.hadoop.mapred.JobConf job, org.apache.hadoop.mapred.Reporter reporter)
static void	setFilterSpatialOperationConfig(SpatialOperationConfig spatialOpConf, org.apache.hadoop.conf.Configuration conf) Sets an input-format specific SpatialOperationConfig.
static void	setFilterSpatialOperationConfig(SpatialOperationConfig spatialOpConf, java.lang.Integer dataSetId, org.apache.hadoop.conf.Configuration conf) Sets an input-format-dataset specific SpatialOperationConfig.

Methods inherited from class org.apache.hadoop.mapred.SequenceFileInputFormat

listStatus

Methods inherited from class org.apache.hadoop.mapred.FileInputFormat

addInputPath, addInputPaths, computeSplitSize, getBlockIndex, getInputPathFilter, getInputPaths, getSplitHosts, getSplits, isSplitable, setInputPathFilter, setInputPaths, setInputPaths, setMinSplitSize

Methods inherited from class java.lang.Object

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

Field Detail

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

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

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

SPATIAL_OP_LU_CHAIN

protected static final java.lang.String[] SPATIAL_OP_LU_CHAIN

Constructor Detail

SpatialIndexInputFormat

public SpatialIndexInputFormat()

Method Detail

setFilterSpatialOperationConfig

public static void setFilterSpatialOperationConfig(SpatialOperationConfig spatialOpConf,
                                                   org.apache.hadoop.conf.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,
                                                   org.apache.hadoop.conf.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

getFilterSpatialOperationConfig

public static SpatialOperationConfig getFilterSpatialOperationConfig(org.apache.hadoop.conf.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,
                                                                     org.apache.hadoop.conf.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 org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.Text,RecordInfo> getRecordReader(org.apache.hadoop.mapred.InputSplit split,
                                                                                                   org.apache.hadoop.mapred.JobConf job,
                                                                                                   org.apache.hadoop.mapred.Reporter reporter)
                                                                                            throws java.io.IOException

Specified by:

getRecordReader in interface org.apache.hadoop.mapred.InputFormat<org.apache.hadoop.io.Text,RecordInfo>

Overrides:

getRecordReader in class org.apache.hadoop.mapred.SequenceFileInputFormat<org.apache.hadoop.io.Text,RecordInfo>

Throws:

java.io.IOException