oracle.odi.domain.dimension

Class OdiParentRef

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiParentRef

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IParentRef, IModelObject, IModelObjectBase, IRepositoryEntity

public class OdiParentRef
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IParentRef

A class to represent a level parent reference to another level. A level can own multiple parent reference objects, each representing a relationship between the owning level and a parent level. The parent references are used by the hierarchies of the dimension, to build up a hierarchical set of levels.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiParentRef.SCD2ParentRefType

Constructor Summary

Constructors

Constructor and Description
OdiParentRef(OdiLevel owningLevel, java.lang.String parentRefName) OdiParentRef constructor.
OdiParentRef(OdiLevel owningLevel, java.lang.String parentRefName, OdiLevel refParentLevel) OdiParentRef constructor.

Method Summary

Modifier and Type	Method and Description
void	addRefMember(OdiRefMember member) Add a reference member to this parent reference.
OdiRefMember	findRefMember(INaturalKeyMember natKeyMem) Find a reference member with the specified natural key member.
java.lang.String	getDescription() Get the text description for this parent reference.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
OdiLevel	getLevel() Get the owning level for this parent reference.
java.lang.String	getName() Get the name of this parent reference.
java.lang.Number	getParentRefId() Get the unique id of this parent ref object.
OdiParentRef.SCD2ParentRefType	getParentRefSCD2Type() Get the parent reference SCD2 type.
OdiLevel	getReferencedParentLevel() Get the referenced parent level that is related to the owning level by this parent reference object.
java.util.List	getRefMembers() Get the ordered list of reference members for this parent reference.
void	removeRefMember(OdiRefMember member) Remove a ref member from this parent ref.
void	setDescription(java.lang.String desc) Set a long text description of this parent reference.
void	setName(java.lang.String name) Set the name of this parent reference.
void	setParentRefSCD2Type(OdiParentRef.SCD2ParentRefType type)
void	setReferencedParentLevel(OdiLevel lev) Set the referenced parent level that is related to the owning level by this parent reference object.
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

OdiParentRef

public OdiParentRef(OdiLevel owningLevel,
                    java.lang.String parentRefName,
                    OdiLevel refParentLevel)

OdiParentRef constructor. The reference members will be created along with the OdiParentRef's creation, and initialized based on the parent level keys. If parent level has surrogate key or both surrogate key and natural key members, the reference member will be set based on the surrogate key; If parent level only has natural key members, the reference members will be set based on the natural key members.

Parameters:

owningLevel - The owning level for this parent reference object. Cannot be set to null.

parentRefName - The name for this parent reference object.

refParentLevel - The parent level for this parent reference object.

OdiParentRef

public OdiParentRef(OdiLevel owningLevel,
                    java.lang.String parentRefName)

OdiParentRef constructor.

Parameters:

owningLevel - The owning level for this parent reference object. Cannot be set to null.

parentRefName - The name for this parent reference object.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IParentRef

Get the name of this parent reference. The name is typically auto-generated and contains the name of the level and the parent level.

Specified by:

getName in interface IParentRef

Specified by:

getName in interface IModelObject

Returns:

the parent reference name.

setName

public void setName(java.lang.String name)

Description copied from interface: IParentRef

Set the name of this parent reference.

Specified by:

setName in interface IParentRef

Parameters:

name - The name to set.

setDescription

public void setDescription(java.lang.String desc)

Description copied from interface: IParentRef

Set a long text description of this parent reference.

Specified by:

setDescription in interface IParentRef

Parameters:

desc - The description to set.

getDescription

public java.lang.String getDescription()

Description copied from interface: IParentRef

Get the text description for this parent reference.

Specified by:

getDescription in interface IParentRef

Returns:

the parent reference description.

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

getParentRefId

public java.lang.Number getParentRefId()

Get the unique id of this parent ref object. It will be unique among all parent refs in this repository.

addRefMember

public void addRefMember(OdiRefMember member)

Add a reference member to this parent reference. The parent reference owns an ordered list of reference member objects, each of which is associated with a parent level natural key member. Alternatively, the parent reference can own one reference member object with no natural key reference. In this case the reference member is assumed to refer to the parent level surrogate key.

Parameters:

member - The reference member to add.

removeRefMember

public void removeRefMember(OdiRefMember member)

Remove a ref member from this parent ref.

Parameters:

member -

getRefMembers

public java.util.List getRefMembers()

Description copied from interface: IParentRef

Get the ordered list of reference members for this parent reference. A parent reference owns an ordered list of reference member objects, each of which is associated with a parent level natural key member. Alternatively, the parent reference can own one reference member object with no natural key reference. In this case the reference member is assumed to refer to the parent level surrogate key.

Specified by:

getRefMembers in interface IParentRef

Returns:

The list of reference members.

findRefMember

public OdiRefMember findRefMember(INaturalKeyMember natKeyMem)

Description copied from interface: IParentRef

Find a reference member with the specified natural key member. If no matching reference member is found, return null

Specified by:

findRefMember in interface IParentRef

Parameters:

natKeyMem - the natural key member to match

Returns:

The matching reference member, or null if none is found.

getLevel

public OdiLevel getLevel()

Description copied from interface: IParentRef

Get the owning level for this parent reference. Each parent references is owned by a level and used by one or more hierarchy members.

Specified by:

getLevel in interface IParentRef

Returns:

the owning Level

getReferencedParentLevel

public OdiLevel getReferencedParentLevel()

Get the referenced parent level that is related to the owning level by this parent reference object. This parent ref object relates a child level to a parent level, for use in a hierarchy. The child level is the object that owns this parent ref object, and the parent level is the referenced parent level.

Specified by:

getReferencedParentLevel in interface IParentRef

Returns:

The parent level.

setReferencedParentLevel

public void setReferencedParentLevel(OdiLevel lev)

Set the referenced parent level that is related to the owning level by this parent reference object.

Specified by:

setReferencedParentLevel in interface IParentRef

toString

public java.lang.String toString()

Overrides:

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

getParentRefSCD2Type

public OdiParentRef.SCD2ParentRefType getParentRefSCD2Type()

Description copied from interface: IParentRef

Get the parent reference SCD2 type.

Specified by:

getParentRefSCD2Type in interface IParentRef

setParentRefSCD2Type

public void setParentRefSCD2Type(OdiParentRef.SCD2ParentRefType type)