oracle.spatial.hadoop.vector.hierarchy

Class HierarchyHelper

java.lang.Object

oracle.spatial.hadoop.vector.hierarchy.HierarchyHelper

public class HierarchyHelper
extends java.lang.Object

Provides convenience methods used internally to manage hierarchical catalogs -related tasks

Author:

hsaucedo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAPRED_KEY_SEPARATOR Separator used in composite keys generated by createMapRedOutputKey(String, String)

Constructor Summary

Constructors

Constructor and Description
HierarchyHelper()

Method Summary

Modifier and Type	Method and Description
static HierarchyInfo	createHierarchyInfo(Configuration conf) Returns an initialized, empty (no content in hierarchy levels) instance of a HierarchyInfo implementation contained in the configuration.
static java.lang.String	createMapRedOutputKey(java.lang.String hlName, java.lang.String id) Creates a key for the given hierarchy level name, feature id which can be used as an output key by a mapper and then read from a reducer
static java.lang.String[]	getHierarchyLevelsNames(HierarchyInfo hierInfo)
static int	getLoadHierarchyFromLevel(HierarchyInfo hierarchyInfo, Configuration conf) Gets the value of the configuration parameter ConfigParams.HIERARCHY_LOAD_MIN_LEVEL.
static int	getLoadHierarchyToLevel(HierarchyInfo hierarchyInfo, Configuration conf) Gets the value of the configuration parameter ConfigParams.HIERARCHY_LOAD_MAX_LEVEL.
static java.lang.String[]	getMapRedOutputKeyComponents(java.lang.String key) Gets the components for a hierarchy level-feature id key created using the method createMapRedOutputKey(String, String)
static void	loadHierarchyLevels(HierarchyInfo hierarchyInfo, Configuration conf) Loads the content for all the hierarchy levels defined in the current job configuration using an initialized HierarchyInfo instance.
static void	loadHierarchyLevels(HierarchyInfo hierarchyInfo, int fromLevel, int toLevel, Configuration conf) Loads the content for the hierarchy levels from fromLevel to toLevel using an initialized HierarchyInfo instance.
static void	setupHierarchyDataIndex(Path[] hierarchyDataPaths, Path hieararchicalIndexPath, HierarchyInfo hierarchyInfo, Configuration conf) If the given hierarchy index exists and is valid it is loaded to the distributed cache, otherwise the hierarchy index is created for the given hierarchy data paths

Methods inherited from class java.lang.Object

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

Field Detail

MAPRED_KEY_SEPARATOR

public static final java.lang.String MAPRED_KEY_SEPARATOR

Separator used in composite keys generated by createMapRedOutputKey(String, String)

See Also:

Constant Field Values

Constructor Detail

HierarchyHelper

public HierarchyHelper()

Method Detail

createHierarchyInfo

public static HierarchyInfo createHierarchyInfo(Configuration conf)
                                         throws java.lang.Exception

Returns an initialized, empty (no content in hierarchy levels) instance of a HierarchyInfo implementation contained in the configuration.

Parameters:

conf - the job configuration

Returns:

a HierarchyInfo instance or null if no hierarchy configuration was found.

Throws:

java.lang.Exception

createMapRedOutputKey

public static java.lang.String createMapRedOutputKey(java.lang.String hlName,
                                                     java.lang.String id)

Creates a key for the given hierarchy level name, feature id which can be used as an output key by a mapper and then read from a reducer

Parameters:

hlName - a hierarchy level name

id - a hierarchy level's feature id

Returns:

a composite key

getHierarchyLevelsNames

public static java.lang.String[] getHierarchyLevelsNames(HierarchyInfo hierInfo)

getLoadHierarchyFromLevel

public static int getLoadHierarchyFromLevel(HierarchyInfo hierarchyInfo,
                                            Configuration conf)

Gets the value of the configuration parameter ConfigParams.HIERARCHY_LOAD_MIN_LEVEL.

Parameters:

hierarchyInfo - the current job's HierarchyInfo instance

conf - the job configuration

Returns:

the value set in the configuration or 1 if it was not set.

getLoadHierarchyToLevel

public static int getLoadHierarchyToLevel(HierarchyInfo hierarchyInfo,
                                          Configuration conf)

Gets the value of the configuration parameter ConfigParams.HIERARCHY_LOAD_MAX_LEVEL.

Parameters:

hierarchyInfo - the current job's HierarchyInfo instance

conf - the job configuration

Returns:

the value set in the configuration or the value returned by HierarchyInfo.getNumberOfLevels()

getMapRedOutputKeyComponents

public static java.lang.String[] getMapRedOutputKeyComponents(java.lang.String key)

Gets the components for a hierarchy level-feature id key created using the method createMapRedOutputKey(String, String)

Parameters:

key - the composite key

Returns:

a two-element array containing the hierarchy level name first and then the feature id

loadHierarchyLevels

public static void loadHierarchyLevels(HierarchyInfo hierarchyInfo,
                                       Configuration conf)
                                throws java.io.IOException

Loads the content for all the hierarchy levels defined in the current job configuration using an initialized HierarchyInfo instance.

Parameters:

hierarchyInfo - an initialized HierarchyInfo. To get an initialized HierarchyInfo call createHierarchyInfo(Configuration)

conf - the job configuration

Throws:

java.io.IOException

loadHierarchyLevels

public static void loadHierarchyLevels(HierarchyInfo hierarchyInfo,
                                       int fromLevel,
                                       int toLevel,
                                       Configuration conf)
                                throws java.io.IOException

Loads the content for the hierarchy levels from fromLevel to toLevel using an initialized HierarchyInfo instance.

Parameters:

hierarchyInfo - an initialized HierarchyInfo. To get an initialized HierarchyInfo call createHierarchyInfo(Configuration)

fromLevel - the minimum level

toLevel - the maximum level

conf - the job configuration

Throws:

java.io.IOException

setupHierarchyDataIndex

public static void setupHierarchyDataIndex(Path[] hierarchyDataPaths,
                                           Path hieararchicalIndexPath,
                                           HierarchyInfo hierarchyInfo,
                                           Configuration conf)
                                    throws java.lang.Exception

If the given hierarchy index exists and is valid it is loaded to the distributed cache, otherwise the hierarchy index is created for the given hierarchy data paths

Parameters:

hierarchyDataPaths - the paths of the hierarchy data to be indexed. If the hierarchy index already exists it will be ignored.

hieararchicalIndexPath - the path of the resulting hierarchy index.

hierarchyInfo - the instance describing the current hierarchy

conf - the job configuration

Throws:

java.io.IOException

java.lang.Exception