oracle.spatial.hadoop.vector.mapred.job

Class IndexedInputBaseJob<K,V>

java.lang.Object

org.apache.hadoop.conf.Configured

oracle.spatial.hadoop.vector.mapred.job.BaseJob<K,V>

oracle.spatial.hadoop.vector.mapred.job.IndexedInputBaseJob<K,V>

Type Parameters:

K - the type of the input keys

V - the type of the input values

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

Direct Known Subclasses:

Binning, Categorization, SpatialFilter

public abstract class IndexedInputBaseJob<K,V>
extends BaseJob<K,V>

Base implementation for jobs which accept a spatial index as input.

Field Summary

Fields inherited from class oracle.spatial.hadoop.vector.mapred.job.BaseJob

argsp, jarClass

Constructor Summary

Constructors

Constructor and Description
IndexedInputBaseJob()

Method Summary

Modifier and Type	Method and Description
void	configure(org.apache.hadoop.mapreduce.Job job)
void	configure(org.apache.hadoop.mapred.JobConf conf) 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.lang.String	getIndexMetadataDir() Gets the path to the directory where the index metadata is located
java.lang.String	getIndexName() Gets the name of the spatial index to be used as input
boolean	isInputIndex() Tells whether the input path is the path to a spatial index.
void	processArgs(java.lang.String[] args, org.apache.hadoop.conf.Configuration conf) Extracts and validates arguments from the command line
void	setIndexMetadataDir(java.lang.String indexMetadataDir) Sets the path to the directory where the index metadata is located
void	setIndexName(java.lang.String indexName) Sets the name of the spatial index to be used as input
void	setInputIndex(boolean inputIndex) Sets whether the input path is the path to a spatial index.

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

createJob, createJob, createJob, createJob, createJobConf, createJobConf, createJobConf, getInput, getInputFormatClass, getJarClass, getOutput, getRecordInfoProviderClass, getSpatialConfig, setInput, setInputFormatClass, setJarClass, setOutput, setRecordInfoProviderClass, setSpatialConfig

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.util.Tool

run

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Constructor Detail

IndexedInputBaseJob

public IndexedInputBaseJob()

Method Detail

getIndexMetadataDir

public java.lang.String getIndexMetadataDir()

Gets the path to the directory where the index metadata is located

Returns:

a path

setIndexMetadataDir

public void setIndexMetadataDir(java.lang.String indexMetadataDir)

Sets the path to the directory where the index metadata is located

Parameters:

indexMetadataDir - a path

getIndexName

public java.lang.String getIndexName()

Gets the name of the spatial index to be used as input

Returns:

a spatial index name

setIndexName

public void setIndexName(java.lang.String indexName)

Sets the name of the spatial index to be used as input

Parameters:

indexName - a spatial index name

isInputIndex

public boolean isInputIndex()

Tells whether the input path is the path to a spatial index. It it used when the input path is set instead of the index name.

Returns:

true if the input path is a spatial index

setInputIndex

public void setInputIndex(boolean inputIndex)

Sets whether the input path is the path to a spatial index. It it used when the input path is set instead of the index name.

Parameters:

inputIndex - true if the input path is a spatial index

processArgs

public void processArgs(java.lang.String[] args,
                        org.apache.hadoop.conf.Configuration conf)

Description copied from class: BaseJob

Extracts and validates arguments from the command line

Overrides:

processArgs in class BaseJob<K,V>

Parameters:

args - arguments from the command line

conf - the job configuration

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

Returns:

a text description

configure

public void configure(org.apache.hadoop.mapred.JobConf conf)
               throws java.lang.Exception

Description copied from class: BaseJob

Validates and adds the current parameters to the job configuration

Overrides:

configure in class BaseJob<K,V>

Parameters:

conf - the job configuration

Throws:

java.lang.Exception

configure

public void configure(org.apache.hadoop.mapreduce.Job job)
               throws java.lang.Exception

Overrides:

configure in class BaseJob<K,V>

Throws:

java.lang.Exception