oracle.odi.domain.adapter.dimensional

Interface ICubeUsesDimension

All Known Implementing Classes:

OdiCubeUsesDimension

public interface ICubeUsesDimension

An interface to represent a dimension level used in a cube. Each cube uses dimension is associated with a dimension level.

Method Summary

Modifier and Type	Method and Description
void	addKeyPartUse(IKeyPartUse pKeyPartUse) Add the key part use into this cube uses dimension.
IKeyPartUse	findKeyPartUse(java.lang.String pLevelAttributeName) Find the key part use with the specified level attribute name.
ICube	getCube() Get the owning cube of this cube uses dimension.
java.util.List	getKeyPartUses() Get a list of key part uses owned by this cube uses dimension.
ILevel	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(IKeyPartUse pKeyPartUse) Remove a key part use from this cube uses dimension.
void	setLevel(ILevel 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.

Method Detail

setRole

void setRole(java.lang.String pRole)

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.

Parameters:

pRole - The role name to be set.

getRole

java.lang.String getRole()

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.

Returns:

The role name.

getPosition

int getPosition()

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

Returns:

The position of this cube uses dimension.

getCube

ICube getCube()

Get the owning cube of this cube uses dimension.

Returns:

The owning cube.

getLevel

ILevel getLevel()

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

Returns:

The referenced dimension level.

setLevel

void setLevel(ILevel pLevel)

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.

Parameters:

pLevel - The referenced dimension level.

getKeyPartUses

java.util.List getKeyPartUses()

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

Returns:

A key part use list.

getOrderedKeyPartUses

java.util.List getOrderedKeyPartUses()

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

Returns:

A sorted key part use list.

findKeyPartUse

IKeyPartUse findKeyPartUse(java.lang.String pLevelAttributeName)

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.

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.

addKeyPartUse

void addKeyPartUse(IKeyPartUse pKeyPartUse)

Add the key part use into this cube uses dimension.

Parameters:

pKeyPartUse - The key part use to be added.

removeKeyPartUse

void removeKeyPartUse(IKeyPartUse pKeyPartUse)

Remove a key part use from this cube uses dimension.

Parameters:

pKeyPartUse - The key part use to be removed.