oracle.odi.domain.dimension

Class OdiHierarchyMember

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiHierarchyMember

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IHierarchyMember, IModelObjectBase, IRepositoryEntity

public class OdiHierarchyMember
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IHierarchyMember

A class to represent a hierarchy member in a dimension hierarchy. A hierarchy member references a level and a parent reference object that defines the parent level for the hierarchy member.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiHierarchyMember(OdiHierarchy hier) OdiHierarchyMember constructor.
OdiHierarchyMember(OdiHierarchy hier, OdiLevel hierLevel) OdiHierarchyMember constructor.
OdiHierarchyMember(OdiHierarchy hier, OdiLevel hierLevel, OdiLevel parentLevel) OdiHierarchyMember constructor.
OdiHierarchyMember(OdiHierarchy hier, OdiParentRef pRef) OdiHierarchyMember constructor.

Method Summary

Modifier and Type	Method and Description
void	addSkipLevel(OdiSkipLevel skipLev) Add a skip level object to this hierarchy member.
OdiHierarchy	getHierarchy() Get the owning hierarchy for this hierarchy member.
java.lang.Number	getHierarchyMemberId() Get the unique id for this hierarchy member.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
OdiLevel	getLevel()
OdiParentRef	getParentRef()
int	getPosition() Get the display position of this hierarchy member.
java.util.List	getSkipLevels() Get the list of skip level objects associated with this hierarchy member.
void	removeSkipLevel(OdiSkipLevel skipLev) Remove a skip level object from this hierarchy member.
void	setLevel(OdiLevel hierLevel) Set the associated level for this hierarchy member.
void	setParentRef(OdiParentRef parentRef) Set the parent ref object for this hierarchy member.

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode, toString

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getBigNumericId, getGlobalId, getNumericId

Constructor Detail

OdiHierarchyMember

public OdiHierarchyMember(OdiHierarchy hier)

OdiHierarchyMember constructor. The associated level and parent level will be null.

Parameters:

hier - The owning hierarchy for this hierarchy member. Cannot be null.

OdiHierarchyMember

public OdiHierarchyMember(OdiHierarchy hier,
                          OdiLevel hierLevel,
                          OdiLevel parentLevel)

OdiHierarchyMember constructor. Takes a level and a parent level parameter.

Parameters:

hier - The owning hierarchy for this hierarchy member. Cannot be null.

hierLevel - The associated level for this hierarchy member.

parentLevel - The parent level for this hierarchy member. A OdiParentRef object will be found or created to represent the relationship to the parent level.

OdiHierarchyMember

public OdiHierarchyMember(OdiHierarchy hier,
                          OdiLevel hierLevel)

OdiHierarchyMember constructor. Takes a level parameter, but the parent level will be null.

Parameters:

hier - The owning hierarchy for this hierarchy member. Cannot be null.

hierLevel - The associated level for this hierarchy member.

OdiHierarchyMember

public OdiHierarchyMember(OdiHierarchy hier,
                          OdiParentRef pRef)

OdiHierarchyMember constructor. Takes a OdiParentRef parameter, and sets the associated level accordingly.

Parameters:

hier - The owning hierarchy for this hierarchy member. Cannot be null.

pRef - The associated OdiParentRef object for this hierarchy member.

Method Detail

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

Typically a subclass will delegate to a public SomePrimitiveWrapper getId() method. The necessity for the getInternalId() abstract method is solely because the persistence layer needs a way of obtaining the identity irrespective of the actual identity implementation choice.

Returning null from this method will indicate the object has never been saved. This will likely be relied on by some DAO implementations.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

getHierarchyMemberId

public java.lang.Number getHierarchyMemberId()

Get the unique id for this hierarchy member. It will be unique among all hierarchy members in this repository.

getLevel

public OdiLevel getLevel()

Specified by:

getLevel in interface IHierarchyMember

Returns:

The level.

setLevel

public void setLevel(OdiLevel hierLevel)

Set the associated level for this hierarchy member.

Parameters:

level - the Level to set.

getParentRef

public OdiParentRef getParentRef()

Specified by:

getParentRef in interface IHierarchyMember

Returns:

The ParentRef.

setParentRef

public void setParentRef(OdiParentRef parentRef)

Description copied from interface: IHierarchyMember

Set the parent ref object for this hierarchy member.

Specified by:

setParentRef in interface IHierarchyMember

Parameters:

parentRef - The ParentRef to set.

getHierarchy

public OdiHierarchy getHierarchy()

Description copied from interface: IHierarchyMember

Get the owning hierarchy for this hierarchy member.

Specified by:

getHierarchy in interface IHierarchyMember

getSkipLevels

public java.util.List getSkipLevels()

Description copied from interface: IHierarchyMember

Get the list of skip level objects associated with this hierarchy member. A skip level object defines an alternate parent level besides the normal parent level defined by the parent ref object. The alternate parent level that can be used by specific level rows that do not have a normal parent row. These would then not be counted as orphan rows.

Specified by:

getSkipLevels in interface IHierarchyMember

Returns:

The list of associated skip level objects.

addSkipLevel

public void addSkipLevel(OdiSkipLevel skipLev)

Add a skip level object to this hierarchy member. A skip level object defines an alternate parent level besides the normal parent level defined by the parent ref object. The alternate parent level that can be used by specific level rows that do not have a normal parent row. These would then not be counted as orphan rows.

removeSkipLevel

public void removeSkipLevel(OdiSkipLevel skipLev)

Description copied from interface: IHierarchyMember

Remove a skip level object from this hierarchy member.

Specified by:

removeSkipLevel in interface IHierarchyMember

Parameters:

skipLev - The skip level object to remove.

getPosition

public int getPosition()

Description copied from interface: IHierarchyMember

Get the display position of this hierarchy member. The ordering defined by the display position is not necessarily the same as the loading order, which is inferred from the set of parent ref objects that are owned by the levels.

Specified by:

getPosition in interface IHierarchyMember

Returns:

The display position number.