oracle.odi.domain.adapter.dimensional

Interface ILevel

All Superinterfaces:

IModelObject, IModelObjectBase

All Known Implementing Classes:

OdiLevel

public interface ILevel
extends IModelObject

An interface to represent a dimension level. The dimension levels store dimension data in a hierarchical manner.

Method Summary

Modifier and Type	Method and Description
void	addNaturalKeyMember(ILevelAttribute levelAttr) Add a natural key member to the list of natural key objects owned by this level.
ILevelAttribute	findLevelAttribute(java.lang.String name) Find a level attribute with the specified name.
INaturalKeyMember	findNaturalKeyMemberByAttributeName(java.lang.String name) Find a natural key member with the specified name.
IDataStore	getBoundDataStore() Get the bound data store for this level.
IDataStore	getBoundStagingDataStore() Get the bound staging data store for this level.
java.lang.String	getDescription() Get the text description for this level.
IDimension	getDimension() Get the Owning Dimension for this level.
java.util.List	getLevelAttributes() Get the list of level attributes that are owned by 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.
ILevelAttribute	getSCD2CurrentFlagAttribute() Get the level attribute that is acting as the SCD type 2 current flag level attribute.
ILevelAttribute	getSCD2EndDateAttribute() Get the SCD type 2 end date attribute.
ILevelAttribute	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.
ILevelAttribute	getSurrogateKeyAttribute() Get the surrogate key level attribute.
void	moveLevelAttributeAfter(ILevelAttribute levelAttr, ILevelAttribute baseLevelAttr) Reorder the specified level attribute to put it after the specified base level attribute.
void	removeLevelAttribute(ILevelAttribute levelAttr) Remove the specified level attribute from this level.
void	removeParentRef(IParentRef pRef) Remove a parent reference object from this level.
void	setBoundDataStore(IDataStore ds) Set the bound data store for this level.
void	setBoundStagingDataStore(IDataStore 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(ILevelAttribute 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(ILevelAttribute 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(ILevelAttribute 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(ILevelAttribute 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(ILevelAttribute surrogateKeyAttr) Get the surrogate key level attribute.
void	setSurrogateKeyAttribute(java.lang.String keyAttrName) A convenience method to set the surrogate key attribute by name.

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

getBigNumericId, getGlobalId, getNumericId

Method Detail

setName

void setName(java.lang.String levelName)

Set the name for this level.

Parameters:

levelName - The name to set.

getName

java.lang.String getName()

Get the name for this level.

Specified by:

getName in interface IModelObject

Returns:

the level name.

setDescription

void setDescription(java.lang.String desc)

Set a text description for this level.

Parameters:

desc - The text description to set.

getDescription

java.lang.String getDescription()

Get the text description for this level.

Returns:

the level description.

getDimension

IDimension getDimension()

Get the Owning Dimension for this level.

Returns:

the owning dimension.

getParentRefs

java.util.List getParentRefs()

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.

Returns:

The list of parent reference objects.

removeParentRef

void removeParentRef(IParentRef pRef)

Remove a parent reference object from this level.

Parameters:

pRef - The parent reference object to remove.

getLevelAttributes

java.util.List getLevelAttributes()

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.

Returns:

the list of LevelAttribute objects.

moveLevelAttributeAfter

void moveLevelAttributeAfter(ILevelAttribute levelAttr,
                             ILevelAttribute 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.

Parameters:

levelAttr - The level to reorder.

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

removeLevelAttribute

void removeLevelAttribute(ILevelAttribute levelAttr)

Remove the specified level attribute from this level.

Parameters:

levelAttr - The level attribute to be removed.

getSurrogateKeyAttribute

ILevelAttribute getSurrogateKeyAttribute()

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.

Returns:

the surrogate key level attribute.

setSurrogateKeyAttribute

void setSurrogateKeyAttribute(ILevelAttribute surrogateKeyAttr)

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.

Parameters:

surrogateKeyAttr - the level attribute to set as the surrogate key attribute.

setSurrogateKeyAttribute

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

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

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

findLevelAttribute

ILevelAttribute findLevelAttribute(java.lang.String name)

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

Parameters:

name - The name to match.

Returns:

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

findNaturalKeyMemberByAttributeName

INaturalKeyMember findNaturalKeyMemberByAttributeName(java.lang.String name)

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

Parameters:

name - The name to match

Returns:

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

setNaturalKeyAttributes

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

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.

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

java.util.List getNaturalKeyMembers()

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.

Returns:

The list of natural key member objects.

getOrderedNaturalKeyMembers

java.util.List getOrderedNaturalKeyMembers()

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

Returns:

The list of natural key member objects ordered by position.

addNaturalKeyMember

void addNaturalKeyMember(ILevelAttribute levelAttr)

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.

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.

setSCD2TriggerAttribute

void setSCD2TriggerAttribute(ILevelAttribute levelAttr)

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.

Parameters:

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

setSCD2TriggerAttribute

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

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.

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

void setSCD2StartDateAttribute(ILevelAttribute levelAttr)

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.

Parameters:

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

setSCD2StartDateAttribute

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

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.

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

void setSCD2EndDateAttribute(ILevelAttribute levelAttr)

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.

Parameters:

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

setSCD2EndDateAttribute

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

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.

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

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

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.

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

void setSCD2CurrentFlagAttribute(ILevelAttribute levelAttr)

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.

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

ILevelAttribute getSCD2StartDateAttribute()

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.

Returns:

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

getSCD2EndDateAttribute

ILevelAttribute getSCD2EndDateAttribute()

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.

Returns:

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

getSCD2CurrentFlagAttribute

ILevelAttribute getSCD2CurrentFlagAttribute()

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.

Returns:

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

getSCD2TriggerAttributes

java.util.List getSCD2TriggerAttributes()

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.

getBoundDataStore

IDataStore getBoundDataStore()

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.

Returns:

The bound datastore.

getBoundStagingDataStore

IDataStore getBoundStagingDataStore()

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.

Returns:

The bound staging datastore.

setBoundStagingDataStore

void setBoundStagingDataStore(IDataStore stageTable)

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.

Parameters:

stageTable - The bound staging datastore to be set.

setBoundDataStore

void setBoundDataStore(IDataStore ds)

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.

Parameters:

ds - The bound datastore to be set.

getPosition

int getPosition()

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.

Returns:

the level display position.