public class OdiHierarchy extends oracle.odi.domain.support.AbstractRepositoryEntity implements IHierarchy
Constructor and Description |
---|
OdiHierarchy(OdiDimension owningDimension,
java.lang.String hierName)
OdiHierarchy constructor.
|
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()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
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(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.
|
equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode, toString
getBigNumericId, getGlobalId, getNumericId
public OdiHierarchy(OdiDimension owningDimension, java.lang.String hierName)
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.public java.lang.String getName()
IHierarchy
getName
in interface IHierarchy
getName
in interface IModelObject
public void setName(java.lang.String name)
IHierarchy
setName
in interface IHierarchy
public void setDescription(java.lang.String desc)
IHierarchy
setDescription
in interface IHierarchy
desc
- The desciption to set.public java.lang.String getDescription()
IHierarchy
getDescription
in interface IHierarchy
public java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
public java.lang.Number getHierarchyId()
public OdiDimension getDimension()
IHierarchy
getDimension
in interface IHierarchy
public void setPosition(int value)
IHierarchy
setPosition
in interface IHierarchy
value
- The position value to set.public int getPosition()
IHierarchy
getPosition
in interface IHierarchy
public boolean isDefaultHierarchy()
IHierarchy
isDefaultHierarchy
in interface IHierarchy
public void setIsDefaultHierarchy(boolean value)
public java.util.List getHierarchyMembers()
getHierarchyMembers
in interface IHierarchy
public java.util.List getHierarchyMembersOrderedByPosition()
IHierarchy
getHierarchyMembersOrderedByPosition
in interface IHierarchy
public java.util.List getHierarchyMembersOrderedForLoading()
getHierarchyMembersOrderedForLoading
in interface IHierarchy
public void addHierarchyMember(OdiHierarchyMember member)
public void removeHierarchyMember(OdiHierarchyMember member)
IHierarchy
removeHierarchyMember
in interface IHierarchy
member
- The member to remove.public OdiHierarchyMember findHierarchyMember(OdiLevel level)
findHierarchyMember
in interface IHierarchy
level
- public void moveHierarchyMemberAfter(OdiHierarchyMember hierMember, OdiHierarchyMember afterHierMember)
IHierarchy
moveHierarchyMemberAfter
in interface IHierarchy
hierMember
- The hierarchy member to move.afterHierMember
- The hierarchy member after which the first hierarchy member will be moved.public void moveHierarchyMemberBefore(OdiHierarchyMember hierMember, OdiHierarchyMember beforeHierMember)
IHierarchy
moveHierarchyMemberBefore
in interface IHierarchy
hierMember
- The hierarchy member to move.beforeHierMember
- The hierarchy member before which the first hierarchy member will be moved.