oracle.odi.domain.dimension

Class OdiLevel

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiLevel

All Implemented Interfaces:

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

public class OdiLevel
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements ILevel

A class to represent a dimension level. The dimension levels store dimension data in a hierarchical manner.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiLevel(OdiDimension owningDim, OdiLevel baseLevel, java.lang.String levelName) OdiLevel constructor The new level will copy base level's attributes including data type/ surrogate key/ SCD2 type/ SCD3 effective date attribute/ SCD3 prior value attribute/ defaultValue, and also natural key members of the base level.
OdiLevel(OdiDimension owningDim, java.lang.String levelName) OdiLevel constructor.

Method Summary

Modifier and Type	Method and Description
void	addLevelAttribute(OdiLevelAttribute levelAttr) Add a level attribute to this level.
void	addNaturalKeyMember(OdiLevelAttribute levelAttr) Add a natural key member to the list of natural key objects owned by this level.
void	addNaturalKeyMember(OdiNaturalKeyMember keyMember) Add a natural key member attribute to the list of natural key objects owned by this level.
void	addParentRef(OdiParentRef pRef) Add a parent ref objects that will be associated with this level.
OdiLevelAttribute	findLevelAttribute(java.lang.String name) Find a level attribute with the specified name.
OdiNaturalKeyMember	findNaturalKeyMemberByAttributeName(java.lang.String name) Find a natural key member with the specified name.
OdiDataStore	getBoundDataStore() Get the bound data store for this level.
OdiDataStore	getBoundStagingDataStore() Get the bound staging data store for this level.
java.lang.String	getDescription() Get the text description for this level.
OdiDimension	getDimension() Get the Owning Dimension for this level.
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.util.List	getLevelAttributes() Get the list of level attributes that are owned by this level.
java.lang.Number	getLevelId() Get the unique id for this level.
java.lang.String	getName() Get the name for this level.
java.util.List	getNaturalKeyMembers() Get the ordered list of natural key member objects owned by this level.
java.util.List	getOrderedNaturalKeyMembers() Get the list of natural key member objects owned by this level, sorted by display order.
java.util.List	getParentRefs() Get the list of parent ref objects associated with this level.
int	getPosition() Get the display position number for this level.
OdiLevelAttribute	getSCD2CurrentFlagAttribute() Get the level attribute that is acting as the SCD type 2 current flag level attribute.
OdiLevelAttribute	getSCD2EndDateAttribute() Get the SCD type 2 end date attribute.
OdiLevelAttribute	getSCD2StartDateAttribute() Get the SCD type 2 start date attribute.
java.util.List	getSCD2TriggerAttributes() Get the list of SCD type 2 trigger level attributes, by name.
OdiLevelAttribute	getSurrogateKeyAttribute() Get the surrogate key level attribute.
void	moveLevelAttributeAfter(OdiLevelAttribute levelAttr, OdiLevelAttribute baseLevelAttr) Reorder the specified level attribute to put it after the specified base level attribute.
void	removeLevelAttribute(OdiLevelAttribute levelAttr) Remove the specified level attribute from this level.
void	removeNaturalKeyMember(OdiNaturalKeyMember member)
void	removeParentRef(OdiParentRef pRef) Remove a parent reference object from this level.
void	resetParentRefKeyMember(boolean value)
void	setBoundDataStore(OdiDataStore ds) Set the bound data store for this level.
void	setBoundStagingDataStore(OdiDataStore stageTable) Set the bound staging data store for this level.
void	setDescription(java.lang.String desc) Set a text description for this level.
void	setName(java.lang.String levelName) Set the name for this level.
void	setNaturalKeyAttributes(java.lang.String[] keyAttrNames) Set a set of level attributes as natural key attributes, by name.
void	setSCD2CurrentFlagAttribute(OdiLevelAttribute levelAttr) Set the specified attribute as an SCD type 2 current flag.
void	setSCD2CurrentFlagAttribute(java.lang.String attrName) Set the specified attribute as an SCD type 2 current flag, by name.
void	setSCD2EndDateAttribute(OdiLevelAttribute levelAttr) Set the specified attribute as an SCD type 2 end date attribute.
void	setSCD2EndDateAttribute(java.lang.String attrName) Set the specified attribute as an SCD type 2 end date attribute, by name.
void	setSCD2StartDateAttribute(OdiLevelAttribute levelAttr) Set the specified attribute as an SCD type 2 start date attribute.
void	setSCD2StartDateAttribute(java.lang.String attrName) Set the specified attribute as an SCD type 2 start date attribute, by name.
void	setSCD2TriggerAttribute(OdiLevelAttribute levelAttr) Set the specified attribute as an SCD type 2 trigger attribute.
void	setSCD2TriggerAttribute(java.lang.String attrName) Set the specified attribute as an SCD type 2 trigger attribute, by name.
void	setSurrogateKeyAttribute(OdiLevelAttribute surrogateKeyAttr) Get the surrogate key level attribute.
void	setSurrogateKeyAttribute(java.lang.String keyAttrName) A convenience method to set the surrogate key attribute by name.
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

OdiLevel

public OdiLevel(OdiDimension owningDim,
                java.lang.String levelName)

OdiLevel constructor.

Parameters:

owningDim - The owning dimension for this level.

levelName - The level name.

OdiLevel

public OdiLevel(OdiDimension owningDim,
                OdiLevel baseLevel,
                java.lang.String levelName)

OdiLevel constructor The new level will copy base level's attributes including data type/ surrogate key/ SCD2 type/ SCD3 effective date attribute/ SCD3 prior value attribute/ defaultValue, and also natural key members of the base level.

Parameters:

owningDim - The owning dimension for this level.

baseLevel - The base Level.

levelName - The level name.

Method Detail

setName

public void setName(java.lang.String levelName)

Description copied from interface: ILevel

Set the name for this level.

Specified by:

setName in interface ILevel

Parameters:

levelName - The name to set.

getName

public java.lang.String getName()

Description copied from interface: ILevel

Get the name for this level.

Specified by:

getName in interface ILevel

Specified by:

getName in interface IModelObject

Returns:

the level name.

setDescription

public void setDescription(java.lang.String desc)

Description copied from interface: ILevel

Set a text description for this level.

Specified by:

setDescription in interface ILevel

Parameters:

desc - The text description to set.

getDescription

public java.lang.String getDescription()

Description copied from interface: ILevel

Get the text description for this level.

Specified by:

getDescription in interface ILevel

Returns:

the level 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

getLevelId

public java.lang.Number getLevelId()

Get the unique id for this level. It will be unique among all levels in this repository.

getDimension

public OdiDimension getDimension()

Description copied from interface: ILevel

Get the Owning Dimension for this level.

Specified by:

getDimension in interface ILevel

Returns:

The OwningDim.

getParentRefs

public java.util.List getParentRefs()

Description copied from interface: ILevel

Get the list of parent ref objects associated with this level. Each parent ref object provides a link between this level and a parent level for this level. The parent level is a level whose row data represents some object that can contain a set of child row objects. The parent level relationships are used for rolling up the dimension data for reporting.

Specified by:

getParentRefs in interface ILevel

Returns:

the ParentRefs

addParentRef

public void addParentRef(OdiParentRef pRef)

Add a parent ref objects that will be associated with this level. Each parent ref object provides a link between this level and a parent level for this level. The parent level is a level whose row data represents some object that can contain a set of child row objects. The parent level relationships are used for rolling up the dimension data for reporting.

Parameters:

pRef - The parent ref object to add.

removeParentRef

public void removeParentRef(OdiParentRef pRef)

Description copied from interface: ILevel

Remove a parent reference object from this level.

Specified by:

removeParentRef in interface ILevel

Parameters:

pRef - The parent reference object to remove.

getLevelAttributes

public java.util.List getLevelAttributes()

Description copied from interface: ILevel

Get the list of level attributes that are owned by this level. Each level attribute represents a data column that will be defined for each level row in the level runtime data.

Specified by:

getLevelAttributes in interface ILevel

Returns:

the LevelAttributes.

addLevelAttribute

public void addLevelAttribute(OdiLevelAttribute levelAttr)

Add a level attribute to this level. Each level attribute represents a data column that will be defined for each level row in the level runtime data.

Parameters:

levelAttr - The LevelAttribute to be added.

moveLevelAttributeAfter

public void moveLevelAttributeAfter(OdiLevelAttribute levelAttr,
                                    OdiLevelAttribute baseLevelAttr)

Reorder the specified level attribute to put it after the specified base level attribute. If the base level attribute is null, then put the specified level attribute into position 0.

Specified by:

moveLevelAttributeAfter in interface ILevel

Parameters:

levelAttr - The level to reorder.

baseLevelAttr - The base level. If null, the reordered level will be put first.

removeLevelAttribute

public void removeLevelAttribute(OdiLevelAttribute levelAttr)

Description copied from interface: ILevel

Remove the specified level attribute from this level.

Specified by:

removeLevelAttribute in interface ILevel

Parameters:

levelAttr - The level attribute to be removed.

getSurrogateKeyAttribute

public OdiLevelAttribute getSurrogateKeyAttribute()

Description copied from interface: ILevel

Get the surrogate key level attribute. Only one of the level attributes owned by this level can be defined as the surrogate key attribute. This attribute will be used to store a generated, unique numeric id for each level row in the runtime data.

Specified by:

getSurrogateKeyAttribute in interface ILevel

Returns:

the SurrogateKey.

setSurrogateKeyAttribute

public void setSurrogateKeyAttribute(OdiLevelAttribute surrogateKeyAttr)

Description copied from interface: ILevel

Get the surrogate key level attribute. Only one of the level attributes owned by this level can be defined as the surrogate key attribute. This attribute will be used to store a generated, unique numeric id for each level row in the runtime data.

Specified by:

setSurrogateKeyAttribute in interface ILevel

Parameters:

surrogateKeyAttr - the SurrogateKey to set

setSurrogateKeyAttribute

public void setSurrogateKeyAttribute(java.lang.String keyAttrName)
                              throws java.lang.Exception

Description copied from interface: ILevel

A convenience method to set the surrogate key attribute by name.

Specified by:

setSurrogateKeyAttribute in interface ILevel

Parameters:

keyAttrName - The name of the level attribute to set as the surrogate key attribute. If no matching level attribute is found, an exception is thrown.

Throws:

java.lang.Exception

resetParentRefKeyMember

public void resetParentRefKeyMember(boolean value)

Parameters:

value -

findLevelAttribute

public OdiLevelAttribute findLevelAttribute(java.lang.String name)

Description copied from interface: ILevel

Find a level attribute with the specified name. If no matching level attribute is found, return null.

Specified by:

findLevelAttribute in interface ILevel

Parameters:

name - The name to match.

Returns:

The matching level attribute, or null if none is found.

findNaturalKeyMemberByAttributeName

public OdiNaturalKeyMember findNaturalKeyMemberByAttributeName(java.lang.String name)

Description copied from interface: ILevel

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

Specified by:

findNaturalKeyMemberByAttributeName in interface ILevel

Parameters:

name - The name to match

Returns:

The matching natural key member, or null if none is found.

setNaturalKeyAttributes

public void setNaturalKeyAttributes(java.lang.String[] keyAttrNames)
                             throws java.lang.Exception

Description copied from interface: ILevel

Set a set of level attributes as natural key attributes, by name. The natural key attributes are a subset of the level attributes owned by this level, that represent a natural unique key for each level row.

Specified by:

setNaturalKeyAttributes in interface ILevel

Parameters:

keyAttrNames - A set of level attribute names used to find a set of level attributes that will be set as the natural key attributes. If any of the names are not found, then an exception is thrown.

Throws:

java.lang.Exception

getNaturalKeyMembers

public java.util.List getNaturalKeyMembers()

Description copied from interface: ILevel

Get the ordered list of natural key member objects owned by this level. Each member key object represents a level attribute that is a natural key. The natural key attributes are an ordered subset of the level attributes owned by this level, that represent a natural unique key for each level row. The order of the key must match the order of the lookup key when loading.

Specified by:

getNaturalKeyMembers in interface ILevel

Returns:

The list of natural key member objects.

getOrderedNaturalKeyMembers

public java.util.List getOrderedNaturalKeyMembers()

Description copied from interface: ILevel

Get the list of natural key member objects owned by this level, sorted by display order.

Specified by:

getOrderedNaturalKeyMembers in interface ILevel

Returns:

The list of natural key member objects ordered by position.

addNaturalKeyMember

public void addNaturalKeyMember(OdiLevelAttribute levelAttr)

Description copied from interface: ILevel

Add a natural key member to the list of natural key objects owned by this level. Each member key object represents a level attribute that is a natural key. The natural key attributes are an ordered subset of the level attributes owned by this level, that represent a natural unique key for each level row. The order of the key must match the order of the lookup key when loading.

Specified by:

addNaturalKeyMember in interface ILevel

Parameters:

levelAttr - The level attribute to add as a natural key member. The new natural key member will be appended to the existing list of members.

addNaturalKeyMember

public void addNaturalKeyMember(OdiNaturalKeyMember keyMember)

Add a natural key member attribute to the list of natural key objects owned by this level. The implementation will create a new natural key member object that references the specified level attribute. Each member key object represents a level attribute that is a natural key. The natural key attributes are an ordered subset of the level attributes owned by this level, that represent a natural unique key for each level row. The order of the key must match the order of the lookup key when loading.

Parameters:

levelAttr - The level attribute to add as a natural key member. The new natural key member will be appended to the existing list of members.

removeNaturalKeyMember

public void removeNaturalKeyMember(OdiNaturalKeyMember member)

setSCD2TriggerAttribute

public void setSCD2TriggerAttribute(OdiLevelAttribute levelAttr)

Description copied from interface: ILevel

Set the specified attribute as an SCD type 2 trigger attribute. The SCD2 trigger attributes are a subset of the level attributes contained by this level. Each SCD2 trigger attribute represents an attribute that will cause an SCD2 history record to be created if the column value of the bound column changes during an update load of the level.

Specified by:

setSCD2TriggerAttribute in interface ILevel

Parameters:

levelAttr - The level attribute to be set as an SCD2 trigger.

setSCD2TriggerAttribute

public void setSCD2TriggerAttribute(java.lang.String attrName)
                             throws java.lang.Exception

Description copied from interface: ILevel

Set the specified attribute as an SCD type 2 trigger attribute, by name. The SCD2 trigger attributes are a subset of the level attributes contained by this level. Each SCD2 trigger attribute represents an attribute that will cause an SCD2 history record to be created if the column value of the bound column changes during an update load of the level.

Specified by:

setSCD2TriggerAttribute in interface ILevel

Parameters:

attrName - The name of a level attribute to be set as an SCD2 trigger. If no matching level attribute is found, an exception is thrown.

Throws:

java.lang.Exception

setSCD2StartDateAttribute

public void setSCD2StartDateAttribute(OdiLevelAttribute levelAttr)

Description copied from interface: ILevel

Set the specified attribute as an SCD type 2 start date attribute. Only one level attribute can act as the SCD2 start date attribute for the level. If an existing level attribute is already set as the SCD2 start date, it will no longer function as the SCD2 start date after this method is called. The SCD2 start date attribute represents the column value in the bound table that will be set to the start date of the historic period for a SCD2 history row.

Specified by:

setSCD2StartDateAttribute in interface ILevel

Parameters:

levelAttr - The level attribute to be set as an SCD2 start date.

setSCD2StartDateAttribute

public void setSCD2StartDateAttribute(java.lang.String attrName)
                               throws java.lang.Exception

Description copied from interface: ILevel

Set the specified attribute as an SCD type 2 start date attribute, by name. Only one level attribute can act as the SCD2 start date attribute for the level. If an existing level attribute is already set as the SCD2 start date, it will no longer function as the SCD2 start date after this method is called. The SCD2 start date attribute represents the column value in the bound table that will be set to the start date of the historic period for a SCD2 history row.

Specified by:

setSCD2StartDateAttribute in interface ILevel

Parameters:

attrName - The name of a level attribute to be set as an SCD2 trigger. If no matching level attribute is found, an exception is thrown.

Throws:

java.lang.Exception

setSCD2EndDateAttribute

public void setSCD2EndDateAttribute(OdiLevelAttribute levelAttr)

Description copied from interface: ILevel

Set the specified attribute as an SCD type 2 end date attribute. Only one level attribute can act as the SCD2 end date attribute for the level. If an existing level attribute is already set as the SCD2 end date, it will no longer function as the SCD2 end date after this method is called. The SCD2 end date attribute represents the column value in the bound table that will be set to the end date of the historic period for a SCD2 history row.

Specified by:

setSCD2EndDateAttribute in interface ILevel

Parameters:

levelAttr - The level attribute to be set as an SCD2 end date.

setSCD2EndDateAttribute

public void setSCD2EndDateAttribute(java.lang.String attrName)
                             throws java.lang.Exception

Description copied from interface: ILevel

Set the specified attribute as an SCD type 2 end date attribute, by name. Only one level attribute can act as the SCD2 end date attribute for the level. If an existing level attribute is already set as the SCD2 end date, it will no longer function as the SCD2 end date after this method is called. The SCD2 end date attribute represents the column value in the bound table that will be set to the end date of the historic period for a SCD2 history row.

Specified by:

setSCD2EndDateAttribute in interface ILevel

Parameters:

attrName - The name of a level attribute to be set as an SCD2 end date. If no matching level attribute is found, an exception is thrown.

Throws:

java.lang.Exception

setSCD2CurrentFlagAttribute

public void setSCD2CurrentFlagAttribute(java.lang.String attrName)
                                 throws java.lang.Exception

Description copied from interface: ILevel

Set the specified attribute as an SCD type 2 current flag, by name. Only one level attribute can act as the SCD2 current flag attribute for the level. If an existing level attribute is already set as the SCD2 current flag, it will no longer function as the SCD2 current flag after this method is called. The SCD2 current flag attribute represents the column value in the bound table that will function as a boolean flag, which when set indicates that the row is the current active record for the set of history records that share a particular natural key.

Specified by:

setSCD2CurrentFlagAttribute in interface ILevel

Parameters:

attrName - The name of a level attribute to be set as an SCD2 current flag. If no matching level attribute is found, an exception is thrown.

Throws:

java.lang.Exception

setSCD2CurrentFlagAttribute

public void setSCD2CurrentFlagAttribute(OdiLevelAttribute levelAttr)

Description copied from interface: ILevel

Set the specified attribute as an SCD type 2 current flag. Only one level attribute can act as the SCD2 current flag attribute for the level. If an existing level attribute is already set as the SCD2 current flag, it will no longer function as the SCD2 current flag after this method is called. The SCD2 current flag attribute represents the column value in the bound table that will function as a boolean flag, which when set indicates that the row is the current active record for the set of history records that share a particular natural key.

Specified by:

setSCD2CurrentFlagAttribute in interface ILevel

Parameters:

levelAttr - The name of a level attribute to be set as an SCD2 current flag. If no matching level attribute is found, an exception is thrown.

getSCD2StartDateAttribute

public OdiLevelAttribute getSCD2StartDateAttribute()

Description copied from interface: ILevel

Get the SCD type 2 start date attribute. The SCD2 start date attribute represents the column value in the bound table that will be set to the start date of the historic period for a SCD2 history row.

Specified by:

getSCD2StartDateAttribute in interface ILevel

Returns:

the SCD2 start date attribute if one is set, else null.

getSCD2EndDateAttribute

public OdiLevelAttribute getSCD2EndDateAttribute()

Description copied from interface: ILevel

Get the SCD type 2 end date attribute. The SCD2 end date attribute represents the column value in the bound table that will be set to the end date of the historic period for a SCD2 history row.

Specified by:

getSCD2EndDateAttribute in interface ILevel

Returns:

The SCD2 end date attribute if one is set, else null.

getSCD2CurrentFlagAttribute

public OdiLevelAttribute getSCD2CurrentFlagAttribute()

Description copied from interface: ILevel

Get the level attribute that is acting as the SCD type 2 current flag level attribute. The SCD2 current flag attribute represents the column value in the bound table that will function as a boolean flag, which when set indicates that the row is the current active record for the set of history records that share a particular natural key.

Specified by:

getSCD2CurrentFlagAttribute in interface ILevel

Returns:

the SCD2 current flag attribute if one is set, else null.

getSCD2TriggerAttributes

public java.util.List getSCD2TriggerAttributes()

Description copied from interface: ILevel

Get the list of SCD type 2 trigger level attributes, by name. The SCD2 trigger attributes are a subset of the level attributes contained by this level. Each SCD2 trigger attribute represents an attribute that will cause an SCD2 history record to be created if the column value of the bound column changes during an update load of the level.

Specified by:

getSCD2TriggerAttributes in interface ILevel

getBoundDataStore

public OdiDataStore getBoundDataStore()

Description copied from interface: ILevel

Get the bound data store for this level. The bound data store the datastore where the runtime level data will be stored. This is only applicable for a snowflake dimension implementation, where each level has its own table.

Specified by:

getBoundDataStore in interface ILevel

Returns:

The bound datastore.

getBoundStagingDataStore

public OdiDataStore getBoundStagingDataStore()

Description copied from interface: ILevel

Get the bound staging data store for this level. The bound staging data store is where the level data will be staged before being loaded into the actual level or dimension table. This is applicable for both star and snowflake dimension models.

Specified by:

getBoundStagingDataStore in interface ILevel

Returns:

The bound staging datastore.

setBoundStagingDataStore

public void setBoundStagingDataStore(OdiDataStore stageTable)

Description copied from interface: ILevel

Set the bound staging data store for this level. The bound staging table is where the level data will be staged before being loaded into the actual level or dimension table. This is applicable for both star and snowflake dimension models.

Specified by:

setBoundStagingDataStore in interface ILevel

Parameters:

stageTable - The bound staging datastore to be set.

setBoundDataStore

public void setBoundDataStore(OdiDataStore ds)

Description copied from interface: ILevel

Set the bound data store for this level. The bound data store is where the runtime level data will be stored. This is only applicable for a snowflake dimension implementation, where each level has its own table.

Specified by:

setBoundDataStore in interface ILevel

Parameters:

ds - The bound datastore to be set.

getPosition

public int getPosition()

Description copied from interface: ILevel

Get the display position number for this level. This ordering is only used for display, it is not necessarily the same as the loading order.

Specified by:

getPosition in interface ILevel

Returns:

the level display position.

toString

public java.lang.String toString()

Overrides:

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