oracle.odi.domain.adapter.dimensional

Interface IKeyPartUse

All Known Implementing Classes:

OdiKeyPartUse

public interface IKeyPartUse

A class to represent a dimension key used in a cube. IKeyPartUse object holds the binding details from the cube to the level . If the level is linked to the cube by its surrogate key, the single IKeyPartUse would point to the level attribute that is the surrogate key for the Level. If the level is linked to the cube by its natural keys, then there would be an IKeyPartUse for each natural key member in that Level. Each IKeyPartUse would be bound to a column in the cube binding table.

Method Summary

Modifier and Type	Method and Description
IColumn	getBoundColumn() Get the bound column of this key part use.
ICubeUsesDimension	getCubeUsesDimension() Get the owning cube uses dimension of this key part use.
INaturalKeyMember	getNaturalKeyUse() Get the natural key member if the referenced level is linked to the cube by its natural keys.
int	getPosition() Get the position of this key part use in its owning cube uses dimension.
ILevelAttribute	getSurrogateKeyUse() Get the surrogate key level attribute if the referenced level is linked to the cube by its surrogate key.
void	setBoundColumn(IColumn boundColumn) Set the bound column for this key part use.

Method Detail

getPosition

int getPosition()

Get the position of this key part use in its owning cube uses dimension. The position number is used for display purposes.

Returns:

The position of this key part use.

getCubeUsesDimension

ICubeUsesDimension getCubeUsesDimension()

Get the owning cube uses dimension of this key part use.

Returns:

the owning cube uses dimension.

getSurrogateKeyUse

ILevelAttribute getSurrogateKeyUse()

Get the surrogate key level attribute if the referenced level is linked to the cube by its surrogate key.

Returns:

The surrogate key level attribute.

getNaturalKeyUse

INaturalKeyMember getNaturalKeyUse()

Get the natural key member if the referenced level is linked to the cube by its natural keys. Each key part use will associate with a natural key member.

Returns:

The natural key member that is associated with this key part use.

getBoundColumn

IColumn getBoundColumn()

Get the bound column of this key part use. The bound column is a column in the cube bound table that corresponds to this key part use. The runtime data for this key part use will be stored in the bound column.

Returns:

The bound column of this key part use.

setBoundColumn

void setBoundColumn(IColumn boundColumn)

Set the bound column for this key part use. The bound column is a column in the cube bound table that corresponds to this key part use. The runtime data for this key part use will be stored in the bound column.

Parameters:

boundColumn - The bound column for this key part use.