oracle.odi.domain.dimension

Class OdiHierarchy

java.lang.Object

AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiHierarchy

All Implemented Interfaces:

IHierarchy, IModelObject, IModelObjectBase

public class OdiHierarchy
extends AbstractRepositoryEntity
implements IHierarchy

A class to represent a dimension hierarchy. The hierarchy is an ordered set of levels in the dimension. Each level in the hierarchy has a parent-child relationship with a parent level or a child level or both. The parent-child relationships define how to roll up the dimension data during reporting, and also define the loading order for the dimension data.

Constructor Summary

Constructors

Constructor and Description
OdiHierarchy(OdiDimension owningDimension, java.lang.String hierName) OdiHierarchy constructor.

Method Summary

Modifier and Type	Method and Description
void	addHierarchyMember(OdiHierarchyMember member)
OdiHierarchyMember	findHierarchyMember(OdiLevel level) Find the hierarchy member associated with the specified level.
java.lang.String	getDescription() Get the text description for this hierarchy.
OdiDimension	getDimension() Get the owning dimension for this hierarchy.
java.lang.Number	getHierarchyId() Get the internal id value for this hierarchy.
java.util.List	getHierarchyMembers()
java.util.List	getHierarchyMembersOrderedByPosition() Get the hierarchy members, sorted by the display position order.
java.util.List	getHierarchyMembersOrderedForLoading() Get a list of the hierarchy members in loading order, from top to bottom.
java.io.Serializable	getInternalId()
java.lang.String	getName() Get the name of this hierarchy.
int	getPosition() Get the display position of this hierarchy.
IRepositoryEntity	getSecurityContainer()
boolean	isDefaultHierarchy() Retrieve the default hierarchy flag for this hierarchy.
void	moveHierarchyMemberAfter(OdiHierarchyMember hierMember, OdiHierarchyMember afterHierMember) Move the specified hierarchy member to a position after the other specified hierarchy member.
void	moveHierarchyMemberBefore(OdiHierarchyMember hierMember, OdiHierarchyMember beforeHierMember) Move the specified hierarchy member to a position before the other specified hierarchy member.
void	removeHierarchyMember(OdiHierarchyMember member) Remove a hierarchy m ember from this hierarchy.
void	setDescription(java.lang.String desc) Set the text description value for this hierarchy.
void	setIsDefaultHierarchy(boolean value)
void	setName(java.lang.String name) Set the name of this hierarchy.
void	setPosition(int value) Set the display position of this hierarchy.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Constructor Detail

OdiHierarchy

public OdiHierarchy(OdiDimension owningDimension,
                    java.lang.String hierName)

OdiHierarchy constructor.

Parameters:

owningDimension - The owning dimension for this hierarchy. Cannot be null.

hierName - The name for this hierarchy. If the name is not unique in the dimension, a unique name will be generated.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IHierarchy

Get the name of this hierarchy.

Specified by:

getName in interface IHierarchy

Specified by:

getName in interface IModelObject

Returns:

The hierarchy name.

setName

public void setName(java.lang.String name)

Description copied from interface: IHierarchy

Set the name of this hierarchy.

Specified by:

setName in interface IHierarchy

setDescription

public void setDescription(java.lang.String desc)

Description copied from interface: IHierarchy

Set the text description value for this hierarchy.

Specified by:

setDescription in interface IHierarchy

Parameters:

desc - The desciption to set.

getDescription

public java.lang.String getDescription()

Description copied from interface: IHierarchy

Get the text description for this hierarchy.

Specified by:

getDescription in interface IHierarchy

Returns:

The hierarchy description.

getInternalId

public java.io.Serializable getInternalId()

getHierarchyId

public java.lang.Number getHierarchyId()

Get the internal id value for this hierarchy. It will be unique among all hierarchy objects in this repository.

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

getDimension

public OdiDimension getDimension()

Description copied from interface: IHierarchy

Get the owning dimension for this hierarchy.

Specified by:

getDimension in interface IHierarchy

Returns:

the owning Dimension

setPosition

public void setPosition(int value)

Description copied from interface: IHierarchy

Set the display position of this hierarchy. The display position value is unique among the hierarchies in the owning dimension. The implementation will enforce its uniqueness by resetting the position of other hierarchies. The value must be positive.

Specified by:

setPosition in interface IHierarchy

Parameters:

value - The position value to set.

getPosition

public int getPosition()

Description copied from interface: IHierarchy

Get the display position of this hierarchy. The display position value is unique among the hierarchies in the owning dimension.

Specified by:

getPosition in interface IHierarchy

Returns:

The hierarchy position.

isDefaultHierarchy

public boolean isDefaultHierarchy()

Description copied from interface: IHierarchy

Retrieve the default hierarchy flag for this hierarchy.

Specified by:

isDefaultHierarchy in interface IHierarchy

Returns:

True if this is the default hierarchy in the dimension. Only one hierarchy per dimension may be set as the default hierarchy.

setIsDefaultHierarchy

public void setIsDefaultHierarchy(boolean value)

getHierarchyMembers

public java.util.List getHierarchyMembers()

Specified by:

getHierarchyMembers in interface IHierarchy

Returns:

the hierarchy members.

getHierarchyMembersOrderedByPosition

public java.util.List getHierarchyMembersOrderedByPosition()

Description copied from interface: IHierarchy

Get the hierarchy members, sorted by the display position order.

Specified by:

getHierarchyMembersOrderedByPosition in interface IHierarchy

Returns:

the hierarchy members, sorted by display order.

getHierarchyMembersOrderedForLoading

public java.util.List getHierarchyMembersOrderedForLoading()

Get a list of the hierarchy members in loading order, from top to bottom. The loading order is the order that the levels should be loaded during the dimension load ETL operation. The loading order is calculated based on the complete set of parent ref objects owned by the levels.

Specified by:

getHierarchyMembersOrderedForLoading in interface IHierarchy

Returns:

addHierarchyMember

public void addHierarchyMember(OdiHierarchyMember member)

removeHierarchyMember

public void removeHierarchyMember(OdiHierarchyMember member)

Description copied from interface: IHierarchy

Remove a hierarchy m ember from this hierarchy.

Specified by:

removeHierarchyMember in interface IHierarchy

Parameters:

member - The member to remove.

findHierarchyMember

public OdiHierarchyMember findHierarchyMember(OdiLevel level)

Find the hierarchy member associated with the specified level. Each hierarchy member is associated with one level, plus a parent reference that points from the associated level to a parent level. If no member is found that is associated with the specified level, return null.

Specified by:

findHierarchyMember in interface IHierarchy

Parameters:

level -

Returns:

moveHierarchyMemberAfter

public void moveHierarchyMemberAfter(OdiHierarchyMember hierMember,
                                     OdiHierarchyMember afterHierMember)

Description copied from interface: IHierarchy

Move the specified hierarchy member to a position after the other specified hierarchy member. If the afterHierMember parameter is null, then the hierarchy member will be moved to the top of the hierarchy list.

Specified by:

moveHierarchyMemberAfter in interface IHierarchy

Parameters:

hierMember - The hierarchy member to move.

afterHierMember - The hierarchy member after which the first hierarchy member will be moved.

moveHierarchyMemberBefore

public void moveHierarchyMemberBefore(OdiHierarchyMember hierMember,
                                      OdiHierarchyMember beforeHierMember)

Description copied from interface: IHierarchy

Move the specified hierarchy member to a position before the other specified hierarchy member. If the beforeHierMember parameter is null, then the hierarchy member will be moved to the bottom of the hierarchy list.

Specified by:

moveHierarchyMemberBefore in interface IHierarchy

Parameters:

hierMember - The hierarchy member to move.

beforeHierMember - The hierarchy member before which the first hierarchy member will be moved.