oracle.spatial.hadoop.vector.mapred.job

Class Categorization<K,V>

java.lang.Object

Configured

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

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

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

Type Parameters:

K - the type of the input keys

V - the type of the input values

Direct Known Subclasses:

Categorization

public class Categorization<K,V>
extends IndexedInputBaseJob<K,V>

This class can be used to run or configure a job for categorizing records of an input dataset into features of a hierarchical dataset.

The result will be a summary file for each hierarchical level containing the number of records from the non-hierarchical dataset per hierarchy level feature.

The categorization can be performed determining a spatial interaction specified by a spatial operation or using MVSuggest.

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
Categorization()

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.
Path[]	getHierarchyDataPaths() Gets the paths to hierarchy data catalogs.
Path	getHierarchyIndexPath() Gets the HDFS path where the hierarchy data index is located or should be placed once it is generated
java.lang.Class<? extends HierarchyInfo>	getHierarchyInfoClass() Gets the HierarchyInfo implementing class which describes the current hierarchy
MVSConfig	getMvsConfig() Gets the MVSuggest configuration
SpatialOperationConfig	getSpatialOperationConfig() Gets the configuration of the spatial operation to be performed
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	setHierarchyDataPaths(Path[] hierarchyDataPaths) Sets the paths to hierarchy data catalogs.
void	setHierarchyIndexPath(Path hieararchyDataIndexPath) Sets the HDFS path where the hierarchy data index is located or should be placed once it is generated
void	setHierarchyInfoClass(java.lang.Class<? extends HierarchyInfo> hierarchyInfoClass) Sets the HierarchyInfo implementing class which describes the current hierarchy
void	setMvsConfig(MVSConfig mvsConfig) Sets the MVSuggest configuration
void	setSpatialOperationConfig(SpatialOperationConfig spatialOperationConfig) Sets the configuration of the spatial operation to be performed.

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

getIndexMetadataDir, getIndexName, isInputIndex, setIndexMetadataDir, setIndexName, setInputIndex

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

Categorization

public Categorization()

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

getHierarchyDataPaths

public Path[] getHierarchyDataPaths()

Gets the paths to hierarchy data catalogs. The paths are expected to be sorted in ascending way according to the hierarchy level each path represents. For example: path[0] is the path to the catalog of the hierarchy level 1, path[1] is the path for hierarchy level 2 and so on.

Returns:

an array of paths

getHierarchyIndexPath

public Path getHierarchyIndexPath()

Gets the HDFS path where the hierarchy data index is located or should be placed once it is generated

Returns:

an HDFS path

getHierarchyInfoClass

public java.lang.Class<? extends HierarchyInfo> getHierarchyInfoClass()

Gets the HierarchyInfo implementing class which describes the current hierarchy

Returns:

a subclass of HierarchyInfo

getMvsConfig

public MVSConfig getMvsConfig()

Gets the MVSuggest configuration

Returns:

the MVSuggest configuration

getSpatialOperationConfig

public SpatialOperationConfig getSpatialOperationConfig()

Gets the configuration of the spatial operation to be performed

Returns:

a spatial operation configuration

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

setHierarchyDataPaths

public void setHierarchyDataPaths(Path[] hierarchyDataPaths)

Sets the paths to hierarchy data catalogs. The paths are expected to be sorted in ascending way according to the hierarchy level each path represents. For example: path[0] is the path to the catalog of the hierarchy level 1, path[1] is the path for hierarchy level 2 and so on.

Parameters:

hierarchyDataPaths - an array of paths

setHierarchyIndexPath

public void setHierarchyIndexPath(Path hieararchyDataIndexPath)

Sets the HDFS path where the hierarchy data index is located or should be placed once it is generated

Parameters:

hieararchyDataIndexPath - an HDFS path

setHierarchyInfoClass

public void setHierarchyInfoClass(java.lang.Class<? extends HierarchyInfo> hierarchyInfoClass)

Sets the HierarchyInfo implementing class which describes the current hierarchy

Parameters:

hierarchyInfoClass - a subclass of HierarchyInfo

setMvsConfig

public void setMvsConfig(MVSConfig mvsConfig)

Sets the MVSuggest configuration

Parameters:

mvsConfig - the MVSuggest configuration

setSpatialOperationConfig

public void setSpatialOperationConfig(SpatialOperationConfig spatialOperationConfig)

Sets the configuration of the spatial operation to be performed. The query window is not needed.

Parameters:

spatialOperationConfig - a spatial operation configuration.