oracle.odi.domain.adapter.dimensional

Interface IParentRef

All Superinterfaces:

IModelObject, IModelObjectBase

All Known Implementing Classes:

OdiParentRef

public interface IParentRef
extends IModelObject

An interface 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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IParentRef.SCD2ParentRefType An enum to represent the SCD2 properties of a parent reference.

Method Summary

Modifier and Type	Method and Description
IRefMember	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.
ILevel	getLevel() Get the owning level for this parent reference.
java.lang.String	getName() Get the name of this parent reference.
java.lang.Enum	getParentRefSCD2Type() Get the parent reference SCD2 type.
ILevel	getReferencedParentLevel() Get the parent level for this parent reference.
java.util.List	getRefMembers() Get the ordered list of reference members for this parent reference.
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	setReferencedParentLevel(ILevel lev) Set the parent level for this parent reference.

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

getBigNumericId, getGlobalId, getNumericId

Method Detail

getName

java.lang.String getName()

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 IModelObject

Returns:

the parent reference name.

setName

void setName(java.lang.String name)

Set the name of this parent reference.

Parameters:

name - The name to set.

setDescription

void setDescription(java.lang.String desc)

Set a long text description of this parent reference.

Parameters:

desc - The description to set.

getDescription

java.lang.String getDescription()

Get the text description for this parent reference.

Returns:

the parent reference description.

getRefMembers

java.util.List getRefMembers()

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.

Returns:

The list of reference members.

getLevel

ILevel getLevel()

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

Returns:

the owning level for this parent reference.

getReferencedParentLevel

ILevel getReferencedParentLevel()

Get the parent level for this parent reference. The parent level defines the parent-child relationship between the owning level and the parent level.

Returns:

The parent level.

setReferencedParentLevel

void setReferencedParentLevel(ILevel lev)

Set the parent level for this parent reference. The parent level defines the parent-child relationship between the owning level and the parent level.

getParentRefSCD2Type

java.lang.Enum getParentRefSCD2Type()

Get the parent reference SCD2 type.

findRefMember

IRefMember findRefMember(INaturalKeyMember natKeyMem)

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

Parameters:

natKeyMem - the natural key member to match

Returns:

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