oracle.spatial.hadoop.vector.hierarchy

Interface HierarchyInfo

All Known Implementing Classes:

DynaAdminHierarchyInfo

public interface HierarchyInfo

Represents a hierarchical catalog. An implementation of this interface is expected to perform the following functions: -Provide the number of hierarchy levels and a way to identify each level. -Provide content such as id and spatial information of each record in a certain hierarchical level. -Provide hierarchical relations between records in different levels such as parent-child associations. The paths of the different hierarchical catalogs are specified at runtime by calling the load() method. It is discouraged to link the implementation with a fixed path. Instead, only the content specified by the load() method should be loaded.

Author:

hsaucedo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNDEFINED_PARENT_ID

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getEntriesIds(int level) Gets the ids of all the elements in the given hierarchy level
JGeometry	getEntryGeometry(int level, java.lang.String entryId) Gets the geometry of the specified entry in the given hierarchy level
java.lang.String	getLevelName(int level) Gets the name which identifies the given hierarchy level number.
int	getLevelNumber(java.lang.String levelName) Gets the number of the hierarchy level identified by the given name
int	getNumberOfLevels() Gets the total number of hierarchy levels
java.lang.String	getParentId(int childLevel, java.lang.String childId) Gets the id of the parent of the given entry
void	initialize(Configuration conf) This method is called always once a new instance is created.
void	load(Path[] hierDataPaths, int fromLevel, JobConf conf) Loads the hierarchical catalog content from the given paths.
void	loadFromIndex(HierarchyDataIndexReader[] readers, int fromLevel, Configuration conf) Loads the hierarchical catalog content from previously generated indices.

Field Detail

UNDEFINED_PARENT_ID

static final java.lang.String UNDEFINED_PARENT_ID

See Also:

Constant Field Values

Method Detail

getEntriesIds

java.util.Collection<java.lang.String> getEntriesIds(int level)

Gets the ids of all the elements in the given hierarchy level

Parameters:

level - a hierarchy level number: a number between 1 and the number of hierarchy levels

Returns:

a collection of text ids

getEntryGeometry

JGeometry getEntryGeometry(int level,
                           java.lang.String entryId)

Gets the geometry of the specified entry in the given hierarchy level

Parameters:

level - the hierarchy level of the entry

entryId - the id of the entry

Returns:

a JGeometry instance

getLevelName

java.lang.String getLevelName(int level)

Gets the name which identifies the given hierarchy level number. It is expected that the catalog file for this level has the same name (without extension) than the one returned by this method.

Parameters:

level - a hierarchy level number: a number between 1 and the number of hierarchy levels

Returns:

the name of the hierarchy level

getLevelNumber

int getLevelNumber(java.lang.String levelName)

Gets the number of the hierarchy level identified by the given name

Parameters:

levelName - a hierarchy level name

Returns:

the hierarchy level number: a value between 1 and the number of hierarchy levels or -1 if the name does not correspond to any hierarchy level

getNumberOfLevels

int getNumberOfLevels()

Gets the total number of hierarchy levels

Returns:

the number of hierarchy levels

getParentId

java.lang.String getParentId(int childLevel,
                             java.lang.String childId)

Gets the id of the parent of the given entry

Parameters:

childLevel - the hierarchy level where the child entry belongs to

childId - the child id

Returns:

the id of the parent entry or null if the child entry does not have a parent

initialize

void initialize(Configuration conf)

This method is called always once a new instance is created. It lets the implementation to load or set any configuration before any of its other methods are called.

Parameters:

conf - a configuration instance

load

void load(Path[] hierDataPaths,
          int fromLevel,
          JobConf conf)
   throws java.lang.Exception

Loads the hierarchical catalog content from the given paths.

Parameters:

hierDataPaths - an array containing paths for each hierarchy level that needs to be loaded. The hierarchy levels to be loaded are determined by the paths array length and the value of fromLevel parameter. The array's length is inside the range: 1 <= length <= number of hierarchies. The paths are ordered by its hierarchy level in ascending way. The path in the array corresponds to the hierarchy level number resulting of adding the element index to the value of the fromLevel parameter (i + fromLevel). For example: for a hierarchy with 10 levels, load from level 6 to 10. In this case, the path array will contain 5 elements and fromValue will be 6. If the 10 levels need to be loaded, the path array length must be 10 and fromValue must be 1.

fromLevel - specifies the hierarchy level from which the hierarchy levels must be loaded. The value is in the range 1<= fromLevel <= number of hierarchies.

conf - the job configuration

Throws:

java.lang.Exception

loadFromIndex

void loadFromIndex(HierarchyDataIndexReader[] readers,
                   int fromLevel,
                   Configuration conf)
            throws java.lang.Exception

Loads the hierarchical catalog content from previously generated indices. As with the load() method, the number and hierarchies loaded as the top hierarchy level loaded depends on the length of the readers array parameter and the value of the fromLevel parameter.

Parameters:

readers - an array of HierarchyDataIndexReader. The readers are sorted by hierarchy level in ascending order. The top hierarchy level is determined by the value of fromLevel.

fromLevel - specifies the hierarchy level from which the hierarchy levels must be loaded. The value is in the range 1<= fromLevel <= number of hierarchies.

conf - the job configuration

Throws:

java.lang.Exception