oracle.odi.domain.adapter.dimensional

Interface IRefMember

All Superinterfaces:

IModelObjectBase

All Known Implementing Classes:

OdiRefMember

public interface IRefMember
extends IModelObjectBase

An interface that represents a reference member that is owned by a parent reference object. A reference member contains a reference to an ordered list of parent attributes that define a lookup key for the parent level. The lookup key may be a natural key or a surrogate key. If the reference member has a null natural key member reference, it is assumed to be a reference to the parent level surrogate key.

Method Summary

Modifier and Type	Method and Description
IColumn	getBoundColumn() Get the bound column for this reference member.
IColumn	getBoundStagingColumn() Get the bound staging column for this reference member.
INaturalKeyMember	getNaturalKeyMember() Get the parent level natural key member that is associated with this reference member object.
ILevelAttribute	getParentKeyAttribute() Get the parent level key attribute that is associated with this reference member object.
IParentRef	getParentRef() Get the parent reference that owns this reference member.
void	setBoundColumn(IColumn col) Set the bound column for this reference member.
void	setBoundStagingColumn(IColumn col) Set the bound staging column for this reference member.

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Method Detail

getParentRef

IParentRef getParentRef()

Get the parent reference that owns this reference member.

Returns:

The owning parent reference object.

getNaturalKeyMember

INaturalKeyMember getNaturalKeyMember()

Get the parent level natural key member that is associated with this reference member object. If the parent natural key member value is null, it means that this reference member object refers to the parent level surrogate key.

Returns:

The parent level natural key member, or null.

getParentKeyAttribute

ILevelAttribute getParentKeyAttribute()

Get the parent level key attribute that is associated with this reference member object.

Returns:

if surrogate key enable then return surrogate key attribute, otherwise return natural key attribute.

getBoundColumn

IColumn getBoundColumn()

Get the bound column for this reference member. The bound column is a column in the level bound table that will be used to store the parent reference key value associated with this reference member.

Returns:

The bound column for this reference member.

setBoundColumn

void setBoundColumn(IColumn col)

Set the bound column for this reference member. The bound column is a column in the level bound table that will be used to store the parent reference key value associated with this reference member.

Parameters:

col - The bound column to set.

getBoundStagingColumn

IColumn getBoundStagingColumn()

Get the bound staging column for this reference member. The bound column is a column in the level bound staging table that will be used to store the parent reference key value associated with this reference member.

Returns:

The bound staging column for this reference member.

setBoundStagingColumn

void setBoundStagingColumn(IColumn col)

Set the bound staging column for this reference member. The bound column is a column in the level bound table that will be used to store the parent reference key value associated with this reference member.

Parameters:

col - The bound staging column to set.