oracle.odi.domain.dimension

Class OdiKeyPartUse

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiKeyPartUse

All Implemented Interfaces:

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

public class OdiKeyPartUse
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IKeyPartUse

A class to represent a dimension key used in a cube. OdiKeyPartUse 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 OdiKeyPartUse 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 OdiKeyPartUse for each natural key member in that Level. Each OdiKeyPartUse would be bound to a column in the cube binding table.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiKeyPartUse(OdiCubeUsesDimension pUsesDimension) key part use constructor.
OdiKeyPartUse(OdiCubeUsesDimension pUsesDimension, OdiNaturalKeyMember pNaturalKeyUse) key part use constructor.

Method Summary

Modifier and Type	Method and Description
OdiColumn	getBoundColumn() Get the bound column of this key part use.
OdiCubeUsesDimension	getCubeUsesDimension() Get the owning cube uses dimension of this key part use.
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.Number	getKeyPartUseId() Returns the internal identifier of this key part use.
OdiNaturalKeyMember	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.
OdiLevelAttribute	getSurrogateKeyUse() Get the surrogate key level attribute if the referenced level is linked to the cube by its surrogate key.
void	setBoundColumn(OdiColumn pBoundColumn) Set the bound column for this key part use.
void	setNaturalKeyUse(OdiNaturalKeyMember pNaturalKeyUse) Set the natural key member if the referenced level is linked to the cube by its natural keys.
void	setSurrogateKeyUse(OdiLevelAttribute pSurrogateKeyAttribute) Set the surrogate key level attribute if the referenced level is linked to the cube by its surrogate key.

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

OdiKeyPartUse

public OdiKeyPartUse(OdiCubeUsesDimension pUsesDimension)

key part use constructor. Creates a key part use and adds it to the specified cube uses dimension. As default, the key part use will associate with the surrogate key level attribute if surrogate key exists in the referenced level.

Parameters:

pUsesDimension - The owning cube uses dimension of this key part use.

OdiKeyPartUse

public OdiKeyPartUse(OdiCubeUsesDimension pUsesDimension,
                     OdiNaturalKeyMember pNaturalKeyUse)

key part use constructor. Creates a key part use, adds it to the specified cube uses dimension and associate it with the specified natural key member

Parameters:

pUsesDimension - The owning cube uses dimension of this key part use.

pNaturalKeyUse - A natural key member of the referenced level.

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

getKeyPartUseId

public java.lang.Number getKeyPartUseId()

Returns the internal identifier of this key part use.

Returns:

The key part use internal id.

getPosition

public int getPosition()

Description copied from interface: IKeyPartUse

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

Specified by:

getPosition in interface IKeyPartUse

Returns:

The position of this key part use.

getCubeUsesDimension

public OdiCubeUsesDimension getCubeUsesDimension()

Description copied from interface: IKeyPartUse

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

Specified by:

getCubeUsesDimension in interface IKeyPartUse

Returns:

the owning cube uses dimension.

setSurrogateKeyUse

public void setSurrogateKeyUse(OdiLevelAttribute pSurrogateKeyAttribute)

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

Parameters:

pSurrogateKeyAttribute - The surrogate key attribute to be associated with this key part use.

getSurrogateKeyUse

public OdiLevelAttribute getSurrogateKeyUse()

Description copied from interface: IKeyPartUse

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

Specified by:

getSurrogateKeyUse in interface IKeyPartUse

Returns:

The surrogate key level attribute.

setNaturalKeyUse

public void setNaturalKeyUse(OdiNaturalKeyMember pNaturalKeyUse)

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

Parameters:

pNaturalKeyUse - The natural key member to be associated by this key part use.

getNaturalKeyUse

public OdiNaturalKeyMember getNaturalKeyUse()

Description copied from interface: IKeyPartUse

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.

Specified by:

getNaturalKeyUse in interface IKeyPartUse

Returns:

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

setBoundColumn

public void setBoundColumn(OdiColumn pBoundColumn)

Description copied from interface: IKeyPartUse

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.

Specified by:

setBoundColumn in interface IKeyPartUse

Parameters:

pBoundColumn - The bound column for this key part use.

getBoundColumn

public OdiColumn getBoundColumn()

Description copied from interface: IKeyPartUse

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.

Specified by:

getBoundColumn in interface IKeyPartUse

Returns:

The bound column of this key part use.