oracle.spatial.hadoop.vector.hierarchy

Class HierarchyDataIndexWriter

java.lang.Object

oracle.spatial.hadoop.vector.hierarchy.HierarchyDataIndexWriter

public class HierarchyDataIndexWriter
extends java.lang.Object

Class used to create and write an index for hierarchy data. A hierarchy data index is a map where the keys are parent id's which point to its children. Top level entries (hierarchy 1) or entries without parent are always associated to the key HierarchyInfo.UNDEFINED_PARENT_ID

Author:

hsaucedo

Constructor Summary

Constructors

Constructor and Description
HierarchyDataIndexWriter(HierarchyInfo hierInfo, Path indexPath, JobConf conf) Creates a new instance and sets the HierarchyInfo which contains the hierarchy to be indexed and the path where the generated indices will be stored.

Method Summary

Modifier and Type	Method and Description
Path	writeIndex(int level, JobConf conf) Generates and writes an index for the specified hierarchy level.
Path[]	writeIndices(JobConf conf) Creates and writes an index for each level of the current hierarchy defined by the HierarchyInfo object set at creation time

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchyDataIndexWriter

public HierarchyDataIndexWriter(HierarchyInfo hierInfo,
                                Path indexPath,
                                JobConf conf)
                         throws java.io.IOException

Creates a new instance and sets the HierarchyInfo which contains the hierarchy to be indexed and the path where the generated indices will be stored.

Parameters:

hierInfo - an instance of HierarchyInfo. It is expected that the instance is already initialized and loaded with data.

indexPath - the base path where all the hierarchy indices will be stored. It must be a directory.

conf - the job configuration

Throws:

java.io.IOException

Method Detail

writeIndex

public Path writeIndex(int level,
                       JobConf conf)
                throws java.io.IOException

Generates and writes an index for the specified hierarchy level.

Parameters:

level - the hierarchy level for which the index will be generated

conf - the job configuration

Returns:

the path of the generated index

Throws:

java.io.IOException

writeIndices

public Path[] writeIndices(JobConf conf)
                    throws java.io.IOException

Creates and writes an index for each level of the current hierarchy defined by the HierarchyInfo object set at creation time

Parameters:

conf - the job configuration

Returns:

an array containing the paths of each index created. Paths are sorted by hierarchy level in ascending order.

Throws:

java.io.IOException