oracle.odi.domain.adapter.dimensional

Interface IHierarchy

All Superinterfaces:

IModelObject, IModelObjectBase

All Known Implementing Classes:

OdiHierarchy

public interface IHierarchy
extends IModelObject

An interface 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.

Method Summary

Modifier and Type	Method and Description
IHierarchyMember	findHierarchyMember(ILevel level) Find the hierarchy member associated with the specified level.
java.lang.String	getDescription() Get the text description for this hierarchy.
IDimension	getDimension() Get the owning dimension 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.lang.String	getName() Get the name of this hierarchy.
int	getPosition() Get the display position of this hierarchy.
boolean	isDefaultHierarchy() Retrieve the default hierarchy flag for this hierarchy.
void	moveHierarchyMemberAfter(IHierarchyMember hierMember, IHierarchyMember afterHierMember) Move the specified hierarchy member to a position after the other specified hierarchy member.
void	moveHierarchyMemberBefore(IHierarchyMember hierMember, IHierarchyMember beforeHierMember) Move the specified hierarchy member to a position before the other specified hierarchy member.
void	removeHierarchyMember(IHierarchyMember member) Remove a hierarchy m ember from this hierarchy.
void	setDescription(java.lang.String desc) Set the text description value for this hierarchy.
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 interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Method Detail

getName

java.lang.String getName()

Get the name of this hierarchy.

Specified by:

getName in interface IModelObject

Returns:

The hierarchy name.

setName

void setName(java.lang.String name)

Set the name of this hierarchy.

Parameters:

the - name to set.

setDescription

void setDescription(java.lang.String desc)

Set the text description value for this hierarchy.

Parameters:

desc - The desciption to set.

getDescription

java.lang.String getDescription()

Get the text description for this hierarchy.

Returns:

The hierarchy description.

getDimension

IDimension getDimension()

Get the owning dimension for this hierarchy.

Returns:

The owning dimension.

setPosition

void setPosition(int value)

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.

Parameters:

value - The position value to set.

getPosition

int getPosition()

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

Returns:

The hierarchy position.

isDefaultHierarchy

boolean isDefaultHierarchy()

Retrieve the default hierarchy flag for this hierarchy.

Returns:

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

getHierarchyMembers

java.util.List getHierarchyMembers()

Returns:

The hierarchy members.

getHierarchyMembersOrderedByPosition

java.util.List getHierarchyMembersOrderedByPosition()

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

Returns:

the hierarchy members.

getHierarchyMembersOrderedForLoading

java.util.List getHierarchyMembersOrderedForLoading()

Get a list of the hierarchy members in loading order, from top to bottom. The loading order is inferred from the parent ref objects owned by the dimension levels.

Returns:

The ordered hierarchy members.

moveHierarchyMemberAfter

void moveHierarchyMemberAfter(IHierarchyMember hierMember,
                              IHierarchyMember afterHierMember)

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.

Parameters:

hierMember - The hierarchy member to move.

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

moveHierarchyMemberBefore

void moveHierarchyMemberBefore(IHierarchyMember hierMember,
                               IHierarchyMember beforeHierMember)

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.

Parameters:

hierMember - The hierarchy member to move.

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

removeHierarchyMember

void removeHierarchyMember(IHierarchyMember member)

Remove a hierarchy m ember from this hierarchy.

Parameters:

member - The member to remove.

findHierarchyMember

IHierarchyMember findHierarchyMember(ILevel 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.

Parameters:

level - The level for which to find a hierarchy member.

Returns:

The hierarchy member that is associated with the specified level, if any, else null.