oracle.odi.domain.adapter.dimensional

Interface ILevelAttribute

All Superinterfaces:

IModelObject, IModelObjectBase

All Known Implementing Classes:

OdiLevelAttribute

public interface ILevelAttribute
extends IModelObject

An interface to represent a dimension level attribute. A level attribute represents the column data for the level.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILevelAttribute.LevelAttributeRole An enum interface to indicate the attribute role of this attribute.
static class	ILevelAttribute.SCD2LevelAttributeType An enum to indicate the SCD2 type of the level attribute.
static class	ILevelAttribute.SCD3LevelAttributeType An enum used to indicate the SCD3 type of the level attribute.

Method Summary

Modifier and Type	Method and Description
IColumn	getBoundColumn() Get the bound column for this level attribute.
IColumn	getBoundStagingColumn() Get the bound staging column for this level attribute.
IDataType	getDataType() Get the data type that is associated with this level attribute.
java.lang.String	getDescription() Get the text description for this attribute.
ILevel	getLevel() Get The owning level for this level attribute.
java.lang.String	getName() Get the name for this level attribute.
int	getPosition() Get the position number for this attribute.
java.lang.Integer	getScale() Get the data scale of this level attribute.
java.lang.Enum	getSCD2Type() Get the SCD2 type for this level attribute.
ILevelAttribute	getSCD3EffectiveDateAttr() Get the SCD3 effective date attribute for this attribute.
ILevelAttribute	getSCD3PriorValueAttr() Get the SCD3 prior value attribute for this attribute, if one exists, else return null.
java.lang.Enum	getSCD3Type() Get the SCD3 type for this level attribute.
java.lang.Integer	getSize() Get the data size (length or precision) of this level attribute.
boolean	isNaturalKeyAttr() Retrieve the natural key flag for this attribute.
boolean	isSurrogateKeyAttr() Retrieve the surrogate key flag for this attribute.
void	setBoundColumn(IColumn col) Set the bound column for this level attribute.
void	setBoundStagingColumn(IColumn col) Set the bound staging column for this level attribute.
void	setDataType(IDataType levelAttrDataType) Set the data type that is associated with this level attribute.
void	setDescription(java.lang.String desc) Set the text description for this level attribute.
void	setName(java.lang.String levelAttrName) Set the name for this level attribute.
void	setScale(java.lang.Integer levelAttrScale) Set the data scale of this level attribute.
void	setSCD2Type(java.lang.Enum SCD2Type) Set the SCD2 type for this level attribute.
void	setSCD3EffectiveDateAttr(ILevelAttribute levelAttr) Set the SCD3 effective date attribute for this attribute.
void	setSCD3PriorValueAttr(ILevelAttribute levelAttr) Set the SCD3 prior value attribute for this attribute.
void	setSize(java.lang.Integer size) Set the data size (length or precision) of this level attribute.

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

getBigNumericId, getGlobalId, getNumericId

Method Detail

setName

void setName(java.lang.String levelAttrName)

Set the name for this level attribute.

Parameters:

levelAttrName - The name to set.

getName

java.lang.String getName()

Get the name for this level attribute.

Specified by:

getName in interface IModelObject

Returns:

the level attribute name.

setDescription

void setDescription(java.lang.String desc)

Set the text description for this level attribute.

Parameters:

desc - The description to set.

getDescription

java.lang.String getDescription()

Get the text description for this attribute.

Returns:

the level attribute description.

getDataType

IDataType getDataType()

Get the data type that is associated with this level attribute. The data type is assumed to exist in the generic technology model for the repository. The data type is used to validate the data type of the bound column, at validation or code generation time.

Returns:

the data type object.

setDataType

void setDataType(IDataType levelAttrDataType)

Set the data type that is associated with this level attribute. The data type must be owned by the generic technology model for the repository.

Parameters:

levelAttrDataType - The data type object to set for this level attribute.

getPosition

int getPosition()

Get the position number for this attribute. The position number is used for display purposes.

Returns:

The level attribute position.

getSize

java.lang.Integer getSize()

Get the data size (length or precision) of this level attribute. The size is used to validate the size of the bound column at validation or code generation time.

Returns:

The level attribute data size, or null if not applicable.

setSize

void setSize(java.lang.Integer size)

Set the data size (length or precision) of this level attribute. The size is used to validate the size of the bound column at validation or code generation time.

Parameters:

size - The size value to set.

getScale

java.lang.Integer getScale()

Get the data scale of this level attribute. The scale is used to validate the scale of the bound column at validation or code generation time.

Returns:

The level attribute scale value, or null if not applicable.

setScale

void setScale(java.lang.Integer levelAttrScale)

Set the data scale of this level attribute. The scale is used to validate the scale of the bound column at validation or code generation time.

Parameters:

levelAttrScale - The level attribute scale to set, or null if not applicable.

getLevel

ILevel getLevel()

Get The owning level for this level attribute.

Returns:

the owning level.

getSCD3PriorValueAttr

ILevelAttribute getSCD3PriorValueAttr()

Get the SCD3 prior value attribute for this attribute, if one exists, else return null.

Returns:

the SCD3 prior value attribute.

isSurrogateKeyAttr

boolean isSurrogateKeyAttr()

Retrieve the surrogate key flag for this attribute.

Returns:

true if this level attribute functions as the surrogate key attribute for the level.

isNaturalKeyAttr

boolean isNaturalKeyAttr()

Retrieve the natural key flag for this attribute.

Returns:

true if this level attribute functions as the natural key attribute for the level.

setSCD3PriorValueAttr

void setSCD3PriorValueAttr(ILevelAttribute levelAttr)

Set the SCD3 prior value attribute for this attribute.

Parameters:

levelAttr - The SCD3 prior value attribute to set.

getSCD3EffectiveDateAttr

ILevelAttribute getSCD3EffectiveDateAttr()

Get the SCD3 effective date attribute for this attribute.

Returns:

The SCD3 effective date attribute for this attribute.

setSCD3EffectiveDateAttr

void setSCD3EffectiveDateAttr(ILevelAttribute levelAttr)

Set the SCD3 effective date attribute for this attribute.

Parameters:

levelAttr - The SCD3 effective date attribute to set for this attribute.

setSCD2Type

void setSCD2Type(java.lang.Enum SCD2Type)

Set the SCD2 type for this level attribute. This is a enum value that can indicate the role of the attribute with respect to SCD2 history processing.

Parameters:

SCD2Type - The SCD2 type to set.

getSCD2Type

java.lang.Enum getSCD2Type()

Get the SCD2 type for this level attribute. This is a enum value that can indicate the role of the attribute with respect to SCD2 history processing.

Returns:

The SCD2 type.

getSCD3Type

java.lang.Enum getSCD3Type()

Get the SCD3 type for this level attribute. This is a enum value that can indicate the role of the attribute with respect to SCD3 history processing. To set an SCD3 value for an attribute, it must be specified when setting an SCD3 level attribute for another level attribute.

Returns:

The SCD3 type.

getBoundColumn

IColumn getBoundColumn()

Get the bound column for this level attribute. The bound column is a column in the dimension or level bound table that corresponds to this level attribute. The runtime level data for this level attribute will be stored in the bound column.

Returns:

The bound column.

getBoundStagingColumn

IColumn getBoundStagingColumn()

Get the bound staging column for this level attribute. The bound staging column is a column in the dimension or level bound staging table that corresponds to this level attribute. The runtime level error data for this level attribute will be staged in the bound staging column during the ETL loading of the dimension.

Returns:

The bound staging column.

setBoundColumn

void setBoundColumn(IColumn col)

Set the bound column for this level attribute. The bound column is a column in the dimension or level bound table that corresponds to this level attribute. The runtime level data for this level attribute will be stored in the bound column.

Parameters:

col - The bound column to set.

setBoundStagingColumn

void setBoundStagingColumn(IColumn col)

Set the bound staging column for this level attribute. The bound staging column is a column in the dimension or level bound staging table that corresponds to this level attribute. The runtime level error data for this level attribute will be staged in the bound staging column during the ETL loading of the dimension.

Parameters:

col - The bound staging column to set.