oracle.spatial.hadoop.vector.mapred.job

Class SpatialIndexing<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.SpatialIndexing<K,V>

Type Parameters:

K - the type of keys

V - the typè of the values

All Implemented Interfaces:

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

Direct Known Subclasses:

SpatialIndexing

public class SpatialIndexing<K,V>
extends BaseJob<K,V>

This class can be used to run or configure a job for creating a spatial index over a dataset.

Field Summary

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

argsp, jarClass

Constructor Summary

Constructors

Constructor and Description
SpatialIndexing()

Method Summary

Modifier and Type	Method and Description
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	getIndexName() Gets the index name
java.lang.String	getMetadataDir() Gets the directory where the index metadata will be stored
MVSConfig	getMvsConfig() Gets the current MVSuggest configuration if any
boolean	isMapFileIndex()
boolean	isOverwriteMetadata() Gets whether the index metadata should be overwritten in case it already exists.
static void	main(java.lang.String[] args)
void	processArgs(java.lang.String[] args, org.apache.hadoop.conf.Configuration conf) Extracts and validates arguments from the command line
int	run(java.lang.String[] args)
void	setIndexName(java.lang.String indexName) The name of the index to be created.
void	setMapFileIndex(boolean mapFileIndex)
void	setMetadataDir(java.lang.String metadataDir) Sets the directory where the index metadata will be stored
void	setMvsConfig(MVSConfig mvsConfig) Sets the MVSuggest configuration in case it is used.
void	setOverwriteMetadata(boolean overwriteMetadata) Sets whether the index metadata should be overwritten in case it already exists.

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

configure, 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.conf.Configurable

getConf, setConf

Constructor Detail

SpatialIndexing

public SpatialIndexing()

Method Detail

setMetadataDir

public void setMetadataDir(java.lang.String metadataDir)

Sets the directory where the index metadata will be stored

Parameters:

metadataDir - a path

getMetadataDir

public java.lang.String getMetadataDir()

Gets the directory where the index metadata will be stored

Returns:

the path to the index metadata directory

setIndexName

public void setIndexName(java.lang.String indexName)

The name of the index to be created.

Parameters:

indexName - an index name

getIndexName

public java.lang.String getIndexName()

Gets the index name

Returns:

an index name

setOverwriteMetadata

public void setOverwriteMetadata(boolean overwriteMetadata)

Sets whether the index metadata should be overwritten in case it already exists.

Parameters:

overwriteMetadata - true if the index metadata should be overwritten

isOverwriteMetadata

public boolean isOverwriteMetadata()

Gets whether the index metadata should be overwritten in case it already exists.

Returns:

true if the index metadata can be overwritten

setMvsConfig

public void setMvsConfig(MVSConfig mvsConfig)

Sets the MVSuggest configuration in case it is used.

Parameters:

mvsConfig - the MVSuggest configuration

getMvsConfig

public MVSConfig getMvsConfig()

Gets the current MVSuggest configuration if any

Returns:

the MVSuggest configuration

isMapFileIndex

public boolean isMapFileIndex()

setMapFileIndex

public void setMapFileIndex(boolean mapFileIndex)

processArgs

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

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

Throws:

java.lang.Exception

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

run

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

Throws:

java.lang.Exception

main

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

Throws:

java.lang.Exception