oracle.odi.domain.dimension

Class OdiCubeUsesDimension

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiCubeUsesDimension

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ICubeUsesDimension, IRepositoryEntity

public class OdiCubeUsesDimension
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements ICubeUsesDimension

A class to represent a dimension level used in a cube. Each cube uses dimension is associated with a dimension level.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiCubeUsesDimension(OdiCube pCube) Cube uses dimension constructor.
OdiCubeUsesDimension(OdiCube pCube, OdiLevel pLevel) Cube uses dimension constructor.

Method Summary

Modifier and Type	Method and Description
void	addKeyPartUse(OdiKeyPartUse pKeyPartUse) Add the key part use into this cube uses dimension.
OdiKeyPartUse	findKeyPartUse(java.lang.String pLevelAttributeName) Find the key part use with the specified level attribute name.
OdiCube	getCube() Get the owning cube of this cube uses dimension.
java.lang.Number	getCubeUsesDimensionId() Returns the internal identifier of this cube uses dimension.
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.util.List	getKeyPartUses() Get a list of key part uses owned by this cube uses dimension.
OdiLevel	getLevel() Get the dimension level that is referenced by this cube uses dimension.
java.util.List	getOrderedKeyPartUses() Get a sorted list of key part uses owned by this cube uses dimension.
int	getPosition() Get the position of this cube uses dimension.
java.lang.String	getRole() Get the role name of this cube uses dimension.
void	removeKeyPartUse(OdiKeyPartUse pKeyPartUse) Remove a key part use from this cube uses dimension.
void	setLevel(OdiLevel pLevel) Set the dimension level that is referenced by this cube uses dimension.
void	setRole(java.lang.String pRole) Set the role name for this cube uses dimension.

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

Constructor Detail

OdiCubeUsesDimension

public OdiCubeUsesDimension(OdiCube pCube)

Cube uses dimension constructor. Creates a cube uses dimension and adds it to the specified cube.

Parameters:

pCube - The cube that will contain the new cube uses dimension.

OdiCubeUsesDimension

public OdiCubeUsesDimension(OdiCube pCube,
                            OdiLevel pLevel)

Cube uses dimension constructor. Creates a cube uses dimension, adds in to the specified cube and associate it with the specified dimension level.

Parameters:

pCube - The cube that will contain the new cube uses dimension.

pLevel - The dimension level that is referenced by this cube uses dimension.

Method Detail

setRole

public void setRole(java.lang.String pRole)

Description copied from interface: ICubeUsesDimension

Set the role name for this cube uses dimension. If the owning cube references to the same dimension level multiple times, role name should be set for the cube uses dimension to uniquely identify the same level.

Specified by:

setRole in interface ICubeUsesDimension

Parameters:

pRole - The role name to be set.

getRole

public java.lang.String getRole()

Description copied from interface: ICubeUsesDimension

Get the role name of this cube uses dimension. If the owning cube references to the same dimension level multiple times, role name should be set for the cube uses dimension to uniquely identify the same level.

Specified by:

getRole in interface ICubeUsesDimension

Returns:

The role name.

getPosition

public int getPosition()

Description copied from interface: ICubeUsesDimension

Get the position of this cube uses dimension. The position number is used for display purposes.

Specified by:

getPosition in interface ICubeUsesDimension

Returns:

The position of this cube uses dimension.

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

getCubeUsesDimensionId

public java.lang.Number getCubeUsesDimensionId()

Returns the internal identifier of this cube uses dimension.

Returns:

The cube uses dimension internal id.

getCube

public OdiCube getCube()

Description copied from interface: ICubeUsesDimension

Get the owning cube of this cube uses dimension.

Specified by:

getCube in interface ICubeUsesDimension

Returns:

The owning cube.

getLevel

public OdiLevel getLevel()

Description copied from interface: ICubeUsesDimension

Get the dimension level that is referenced by this cube uses dimension.

Specified by:

getLevel in interface ICubeUsesDimension

Returns:

The referenced dimension level.

setLevel

public void setLevel(OdiLevel pLevel)

Description copied from interface: ICubeUsesDimension

Set the dimension level that is referenced by this cube uses dimension. Changing the referenced level will cause all existing key part uses to be removed and new key part uses to be created according to the new referenced level. If the referenced level of this cube uses dimension has surrogate key, then create key part use based on surrogate key attribute, otherwise create key part use for each natural key member of the referenced level.If a dimension reference of the cube is not associated with a level, it won't be saved.

Specified by:

setLevel in interface ICubeUsesDimension

Parameters:

pLevel - The referenced dimension level.

findKeyPartUse

public OdiKeyPartUse findKeyPartUse(java.lang.String pLevelAttributeName)

Description copied from interface: ICubeUsesDimension

Find the key part use with the specified level attribute name. If the key part use is pointed to the surrogate key of the referenced level, the specified name should be the surrogate key attribute name. If the key part use is pointed to the natural key of the referenced level, the specified name should be the natural key attribute name.

Specified by:

findKeyPartUse in interface ICubeUsesDimension

Parameters:

pLevelAttributeName - The surrogate key attribute name if the surrogate key of the level is linked with the key part use or the natural key attribute name if the natural key of the level is linked with the key part use.

Returns:

The matching key part use, or null if none is found.

getKeyPartUses

public java.util.List getKeyPartUses()

Description copied from interface: ICubeUsesDimension

Get a list of key part uses owned by this cube uses dimension.

Specified by:

getKeyPartUses in interface ICubeUsesDimension

Returns:

A key part use list.

getOrderedKeyPartUses

public java.util.List getOrderedKeyPartUses()

Description copied from interface: ICubeUsesDimension

Get a sorted list of key part uses owned by this cube uses dimension. The key part use is sorted by display order.

Specified by:

getOrderedKeyPartUses in interface ICubeUsesDimension

Returns:

A sorted key part use list.

addKeyPartUse

public void addKeyPartUse(OdiKeyPartUse pKeyPartUse)

Description copied from interface: ICubeUsesDimension

Add the key part use into this cube uses dimension.

Specified by:

addKeyPartUse in interface ICubeUsesDimension

Parameters:

pKeyPartUse - The key part use to be added.

removeKeyPartUse

public void removeKeyPartUse(OdiKeyPartUse pKeyPartUse)

Description copied from interface: ICubeUsesDimension

Remove a key part use from this cube uses dimension.

Specified by:

removeKeyPartUse in interface ICubeUsesDimension

Parameters:

pKeyPartUse - The key part use to be removed.