oracle.spatial.hadoop.vector.mapred.job

Class SpatialIndexing<K,V>

java.lang.Object

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

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.

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
SpatialIndexing()

Method Summary

Modifier and Type	Method and Description
void	configure(JobConf jobConf) 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.util.Map<java.lang.String,java.lang.Object>	getCurrentCmdArgs(Configuration conf) Returns the current driver properties in a map where each key-value is a name and value of a command line argument.
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 <K,V> void	main(java.lang.String[] args)
void	processArgs(java.lang.String[] args, 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

getCmdOptionsWithInputDataSets, getCurrentCmdArgsAsString, getInput, getInputDataSet, getInputFormatClass, getJarClass, getOutput, getRecordInfoProviderClass, getSpatialConfig, setInput, setInputDataSet, setInputFormatClass, setJarClass, setOutput, setRecordInfoProviderClass, setSpatialConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialIndexing

public SpatialIndexing()

Method Detail

configure

public void configure(JobConf jobConf)
               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:

jobConf - a job instance

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

getCurrentCmdArgs

public java.util.Map<java.lang.String,java.lang.Object> getCurrentCmdArgs(Configuration conf)

Description copied from class: BaseJob

Returns the current driver properties in a map where each key-value is a name and value of a command line argument. By printing this information it is possible to know how to execute a similar job from command line

Overrides:

getCurrentCmdArgs in class BaseJob<K,V>

Parameters:

conf - a job configuration

Returns:

a map which entries are of type <String,String> or <String, Map<String, Object>> for multiple input data sets. For nested maps, the entry types are the same than the enclosing map

getIndexName

public java.lang.String getIndexName()

Gets the index name

Returns:

an index name

getMetadataDir

public java.lang.String getMetadataDir()

Gets the directory where the index metadata will be stored

Returns:

the path to the index metadata directory

getMvsConfig

public MVSConfig getMvsConfig()

Gets the current MVSuggest configuration if any

Returns:

the MVSuggest configuration

isMapFileIndex

public boolean isMapFileIndex()

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

main

public static <K,V> void main(java.lang.String[] args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

processArgs

public void processArgs(java.lang.String[] args,
                        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

run

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

Throws:

java.lang.Exception

setIndexName

public void setIndexName(java.lang.String indexName)

The name of the index to be created.

Parameters:

indexName - an index name

setMapFileIndex

public void setMapFileIndex(boolean mapFileIndex)

setMetadataDir

public void setMetadataDir(java.lang.String metadataDir)

Sets the directory where the index metadata will be stored

Parameters:

metadataDir - a path

setMvsConfig

public void setMvsConfig(MVSConfig mvsConfig)

Sets the MVSuggest configuration in case it is used.

Parameters:

mvsConfig - the MVSuggest configuration

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