DynaAdminHierarchyInfo (Oracle Big Data Spatial and Graph Vector Analysis Java API Reference)

java.lang.Object
- oracle.spatial.hadoop.vector.hierarchy.impl.DynaAdminHierarchyInfo

All Implemented Interfaces:: HierarchyInfo

public class DynaAdminHierarchyInfo
extends java.lang.Object
implements HierarchyInfo

An implementation of HierarchyInfo that can be configured to represent a hierarchy structure using the MVSuggest administrative boundary catalogs.

Before setting this class to the job configuration's ConfigParams.HIERARCHY_INFO_CLASS property, an instance should be created and configured with the desired structure.

The following example illustrates how a hierarchy structure for a three-level world admin boundaries is created.

                 //create a new instance
                DynaAdminHierarchyInfo dahi = new DynaAdminHierarchyInfo();
                //add hierarchy levels to the instance
                dahi.addLevel(1, "world_continents", "_id", null);//wolrd continents are related to their children by their "_id" field and do not need a field to join with their parents since it is the hierarchy's top level
                dahi.addLevel(2, "world_countries", "properties.COUNTRY CODE", "properties.CONTINENT");//countries are related to their children by the field "properties.COUNTRY CODE" and to their parents by the field "properties.CONTINENT"
                dahi.addLevel(3, "world_states_provinces", null, "properties.ISO");//states & provinces only need to know how to find their parents (field "properties.ISO") and do not have children as there are no more levels below
                //call initialize to save the hierarchy configuration in the job configuration
                dahi.initialize(conf);//conf is a job configuration

Author:: hsaucedo

Field Summary
- Fields inherited from interface oracle.spatial.hadoop.vector.hierarchy.HierarchyInfo
  UNDEFINED_PARENT_ID

Constructor Summary

Constructors
Constructor and Description

DynaAdminHierarchyInfo()
Creates a new empty instance

Constructors
Constructor and Description
`DynaAdminHierarchyInfo()` Creates a new empty instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLevel(int level, java.lang.String name, java.lang.String childrenJoinField, java.lang.String parentJoinField)` Adds a level to the hierarchy.
`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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DynaAdminHierarchyInfo
```
public DynaAdminHierarchyInfo()
```
    Creates a new empty instance
- Method Detail
  - addLevel
```
public void addLevel(int level,
                     java.lang.String name,
                     java.lang.String childrenJoinField,
                     java.lang.String parentJoinField)
```
    Adds a level to the hierarchy.
    
    Parameters:
    
    level - the hierarchy level number.
    
    name - the hierarchy level name
    
    childrenJoinField - the path to the JSON field used to associate entries of this level with their children. If null is passed, the _id field will be used by default.
    
    parentJoinField - the path to the JSON field used to associate entries of this level with their parent. If null is passed, parents will be searched performing a Within spatial operation between the current record's geometry and the upper level entries geometries until one satisfies the operation.
  - getEntriesIds
```
public java.util.Collection<java.lang.String> getEntriesIds(int level)
```
    Description copied from interface: HierarchyInfo
    
    Gets the ids of all the elements in the given hierarchy level
    
    Specified by:
    
    getEntriesIds in interface HierarchyInfo
    
    Parameters:
    
    level - a hierarchy level number: a number between 1 and the number of hierarchy levels
    
    Returns:
    
    a collection of text ids
  - getEntryGeometry
```
public JGeometry getEntryGeometry(int level,
                                  java.lang.String entryId)
```
    Description copied from interface: HierarchyInfo
    
    Gets the geometry of the specified entry in the given hierarchy level
    
    Specified by:
    
    getEntryGeometry in interface HierarchyInfo
    
    Parameters:
    
    level - the hierarchy level of the entry
    
    entryId - the id of the entry
    
    Returns:
    
    a JGeometry instance
  - getLevelName
```
public java.lang.String getLevelName(int level)
```
    Description copied from interface: HierarchyInfo
    
    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.
    
    Specified by:
    
    getLevelName in interface HierarchyInfo
    
    Parameters:
    
    level - a hierarchy level number: a number between 1 and the number of hierarchy levels
    
    Returns:
    
    the name of the hierarchy level
  - getLevelNumber
```
public int getLevelNumber(java.lang.String levelName)
```
    Description copied from interface: HierarchyInfo
    
    Gets the number of the hierarchy level identified by the given name
    
    Specified by:
    
    getLevelNumber in interface HierarchyInfo
    
    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
```
public int getNumberOfLevels()
```
    Description copied from interface: HierarchyInfo
    
    Gets the total number of hierarchy levels
    
    Specified by:
    
    getNumberOfLevels in interface HierarchyInfo
    
    Returns:
    
    the number of hierarchy levels
  - getParentId
```
public java.lang.String getParentId(int childLevel,
                                    java.lang.String childId)
```
    Description copied from interface: HierarchyInfo
    
    Gets the id of the parent of the given entry
    
    Specified by:
    
    getParentId in interface HierarchyInfo
    
    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
```
public void initialize(Configuration conf)
```
    Description copied from interface: HierarchyInfo
    
    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.
    
    Specified by:
    
    initialize in interface HierarchyInfo
    
    Parameters:
    
    conf - a configuration instance
  - load
```
public void load(Path[] hierDataPaths,
                 int fromLevel,
                 JobConf conf)
          throws java.lang.Exception
```
    Description copied from interface: HierarchyInfo
    
    Loads the hierarchical catalog content from the given paths.
    
    Specified by:
    
    load in interface HierarchyInfo
    
    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
```
public void loadFromIndex(HierarchyDataIndexReader[] readers,
                          int fromLevel,
                          Configuration conf)
                   throws java.lang.Exception
```
    Description copied from interface: HierarchyInfo
    
    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.
    
    Specified by:
    
    loadFromIndex in interface HierarchyInfo
    
    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

Class DynaAdminHierarchyInfo

Field Summary

Fields inherited from interface oracle.spatial.hadoop.vector.hierarchy.HierarchyInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DynaAdminHierarchyInfo

Method Detail

addLevel

getEntriesIds

getEntryGeometry

getLevelName

getLevelNumber

getNumberOfLevels

getParentId

initialize

load

loadFromIndex