oracle.odi.domain.dimension

Class OdiRefMember

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiRefMember

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRefMember, IModelObjectBase, IRepositoryEntity

public class OdiRefMember
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IRefMember

A class 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiRefMember(OdiParentRef owningParentRef, OdiNaturalKeyMember refNaturalKeyMember)

Method Summary

Modifier and Type	Method and Description
OdiColumn	getBoundColumn() Get the bound column for this reference member.
OdiColumn	getBoundStagingColumn() Get the bound staging column for this reference member.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
OdiNaturalKeyMember	getNaturalKeyMember() Get the parent level natural key member that is associated with this reference member object.
OdiLevelAttribute	getParentKeyAttribute() Get the parent level key attribute that is associated with this reference member object.
OdiParentRef	getParentRef() Get the parent reference that owns this reference member.
java.lang.Number	getRefMemberId() Get the unique id of this ref member.
void	setBoundColumn(OdiColumn col) Set the bound column for this reference member.
void	setBoundStagingColumn(OdiColumn col) Set the bound staging column for this reference member.
void	setNaturalKeyMember(OdiNaturalKeyMember keyMember)
java.lang.String	toString()

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getBigNumericId, getGlobalId, getNumericId

Constructor Detail

OdiRefMember

public OdiRefMember(OdiParentRef owningParentRef,
                    OdiNaturalKeyMember refNaturalKeyMember)

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

getRefMemberId

public java.lang.Number getRefMemberId()

Get the unique id of this ref member. It will be unique among all ref members in this repository.

getParentRef

public OdiParentRef getParentRef()

Description copied from interface: IRefMember

Get the parent reference that owns this reference member.

Specified by:

getParentRef in interface IRefMember

Returns:

The owning parent reference object.

getNaturalKeyMember

public OdiNaturalKeyMember getNaturalKeyMember()

Description copied from interface: IRefMember

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.

Specified by:

getNaturalKeyMember in interface IRefMember

Returns:

The parent level natural key member, or null.

setNaturalKeyMember

public void setNaturalKeyMember(OdiNaturalKeyMember keyMember)

getBoundColumn

public OdiColumn getBoundColumn()

Description copied from interface: IRefMember

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.

Specified by:

getBoundColumn in interface IRefMember

Returns:

The bound column for this reference member.

setBoundColumn

public void setBoundColumn(OdiColumn col)

Description copied from interface: IRefMember

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.

Specified by:

setBoundColumn in interface IRefMember

Parameters:

col - The bound column to set.

getBoundStagingColumn

public OdiColumn getBoundStagingColumn()

Description copied from interface: IRefMember

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.

Specified by:

getBoundStagingColumn in interface IRefMember

Returns:

The bound staging column for this reference member.

setBoundStagingColumn

public void setBoundStagingColumn(OdiColumn col)

Description copied from interface: IRefMember

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.

Specified by:

setBoundStagingColumn in interface IRefMember

Parameters:

col - The bound staging column to set.

getParentKeyAttribute

public OdiLevelAttribute getParentKeyAttribute()

Description copied from interface: IRefMember

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

Specified by:

getParentKeyAttribute in interface IRefMember

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class oracle.odi.domain.support.AbstractRepositoryEntity