oracle.odi.domain.dimension

Class OdiLevelAttribute

java.lang.Object

AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiLevelAttribute

All Implemented Interfaces:

ILevelAttribute, IModelObject, IModelObjectBase

public class OdiLevelAttribute
extends AbstractRepositoryEntity
implements ILevelAttribute

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
OdiLevelAttribute(OdiLevel owningLevel, java.lang.String name) OdiLevelAttribute constructor.
OdiLevelAttribute(OdiLevel owningLevel, java.lang.String levelAttrName, OdiDataType levelAttrDataType, java.lang.Integer levelAttrLength, java.lang.Integer levelAttrScale) OdiLevelAttribute constructor.

Method Summary

Modifier and Type	Method and Description
OdiColumn	getBoundColumn() Get the bound column for this level attribute.
OdiColumn	getBoundStagingColumn() Get the bound staging column for this level attribute.
OdiDataType	getDataType() Get the data type that is associated with this level attribute.
java.lang.String	getDescription() Get the text description for this attribute.
java.io.Serializable	getInternalId()
OdiLevel	getLevel() Get The owning level for this level attribute.
java.lang.Number	getLevelAttributeId() Get the unique id of 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.
OdiLevelAttribute.SCD2LevelAttributeType	getSCD2Type() Get the SCD2 type for this level attribute.
OdiLevelAttribute	getSCD3EffectiveDateAttr() Get the SCD3 effective date attribute for this attribute.
OdiLevelAttribute	getSCD3PriorValueAttr() Get the SCD3 prior value attribute for this attribute, if one exists, else return null.
OdiLevelAttribute.SCD3LevelAttributeType	getSCD3Type() Get the SCD3 type for this level attribute.
IRepositoryEntity	getSecurityContainer()
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(OdiColumn col) Set the bound column for this level attribute.
void	setBoundStagingColumn(OdiColumn col) Set the bound staging column for this level attribute.
void	setDataType(OdiDataType 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	setIsSurrogateKeyAttr(boolean value) Set or clear this level attribute as the surrogate key attribute for the owning level.
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(OdiLevelAttribute.SCD2LevelAttributeType SCD2Type) Set the SCD2 type for this level attribute.
void	setSCD3EffectiveDateAttr(OdiLevelAttribute levelAttr) Set the SCD3 effective date attribute for this attribute.
void	setSCD3PriorValueAttr(OdiLevelAttribute 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 class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getBigNumericId, getGlobalId, getNumericId

Constructor Detail

OdiLevelAttribute

public OdiLevelAttribute(OdiLevel owningLevel,
                         java.lang.String name)

OdiLevelAttribute constructor. The data type, size, scale, and default value will all be set to null.

Parameters:

owningLevel - The owning level for this level attribute. Cannot be null.

name - The name of the level attribute. If the passed-in name value is not unique in the owning level, a unique name will be generated.

OdiLevelAttribute

public OdiLevelAttribute(OdiLevel owningLevel,
                         java.lang.String levelAttrName,
                         OdiDataType levelAttrDataType,
                         java.lang.Integer levelAttrLength,
                         java.lang.Integer levelAttrScale)

OdiLevelAttribute constructor.

Parameters:

owningLevel - The owning level for this level attribute. Cannot be null.

levelAttrName - The name of the level attribute. If the passed-in name is not unique in the level, a \ unique name will be generated.

levelAttrDataType - The level attribute data type. It must be a data type owned by the generic technology.

levelAttrLength - The data length/precision or size for the level attribute. Can be set to null if size is not applicable for the data type.

levelAttrScale - The data scale for the level attribute. Can be set to null if scale is not applicable for the data type.

Method Detail

setName

public void setName(java.lang.String levelAttrName)

Description copied from interface: ILevelAttribute

Set the name for this level attribute.

Specified by:

setName in interface ILevelAttribute

Parameters:

levelAttrName - The name to set.

getName

public java.lang.String getName()

Description copied from interface: ILevelAttribute

Get the name for this level attribute.

Specified by:

getName in interface ILevelAttribute

Specified by:

getName in interface IModelObject

Returns:

the level attribute name.

setDescription

public void setDescription(java.lang.String desc)

Description copied from interface: ILevelAttribute

Set the text description for this level attribute.

Specified by:

setDescription in interface ILevelAttribute

Parameters:

desc - The description to set.

getDescription

public java.lang.String getDescription()

Description copied from interface: ILevelAttribute

Get the text description for this attribute.

Specified by:

getDescription in interface ILevelAttribute

Returns:

the level attribute description.

getInternalId

public java.io.Serializable getInternalId()

getLevelAttributeId

public java.lang.Number getLevelAttributeId()

Get the unique id of this level attribute. It will be unique among all level attributes in this repository.

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

getDataType

public OdiDataType getDataType()

Description copied from interface: ILevelAttribute

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.

Specified by:

getDataType in interface ILevelAttribute

Returns:

the data type object.

setDataType

public void setDataType(OdiDataType levelAttrDataType)

Description copied from interface: ILevelAttribute

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.

Specified by:

setDataType in interface ILevelAttribute

Parameters:

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

getPosition

public int getPosition()

Description copied from interface: ILevelAttribute

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

Specified by:

getPosition in interface ILevelAttribute

Returns:

The level attribute position.

getSize

public java.lang.Integer getSize()

Description copied from interface: ILevelAttribute

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.

Specified by:

getSize in interface ILevelAttribute

Returns:

the size (length or precision).

setSize

public void setSize(java.lang.Integer size)

Description copied from interface: ILevelAttribute

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.

Specified by:

setSize in interface ILevelAttribute

Parameters:

size - The size to set

getScale

public java.lang.Integer getScale()

Description copied from interface: ILevelAttribute

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.

Specified by:

getScale in interface ILevelAttribute

Returns:

the scale

setScale

public void setScale(java.lang.Integer levelAttrScale)

Description copied from interface: ILevelAttribute

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.

Specified by:

setScale in interface ILevelAttribute

Parameters:

scale - the scale to set

getLevel

public OdiLevel getLevel()

Description copied from interface: ILevelAttribute

Get The owning level for this level attribute.

Specified by:

getLevel in interface ILevelAttribute

Returns:

The owning Level

getSCD3PriorValueAttr

public OdiLevelAttribute getSCD3PriorValueAttr()

Description copied from interface: ILevelAttribute

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

Specified by:

getSCD3PriorValueAttr in interface ILevelAttribute

Returns:

The SCD3 prior value attribute.

setSCD3PriorValueAttr

public void setSCD3PriorValueAttr(OdiLevelAttribute levelAttr)

Description copied from interface: ILevelAttribute

Set the SCD3 prior value attribute for this attribute.

Specified by:

setSCD3PriorValueAttr in interface ILevelAttribute

Parameters:

SCD3PriorValue - The SCD3 prior value attribute.

isSurrogateKeyAttr

public boolean isSurrogateKeyAttr()

Description copied from interface: ILevelAttribute

Retrieve the surrogate key flag for this attribute.

Specified by:

isSurrogateKeyAttr in interface ILevelAttribute

Returns:

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

setIsSurrogateKeyAttr

public void setIsSurrogateKeyAttr(boolean value)

Set or clear this level attribute as the surrogate key attribute for the owning level.

Parameters:

value - If true, set this as the surrogate key attribute, if false, clear the surrogate key flag so that this level attribute will not function as the surrogate key level attribute.

getSCD3EffectiveDateAttr

public OdiLevelAttribute getSCD3EffectiveDateAttr()

Description copied from interface: ILevelAttribute

Get the SCD3 effective date attribute for this attribute.

Specified by:

getSCD3EffectiveDateAttr in interface ILevelAttribute

Returns:

The SCD3 effective date attribute for this attribute.

setSCD3EffectiveDateAttr

public void setSCD3EffectiveDateAttr(OdiLevelAttribute levelAttr)

Description copied from interface: ILevelAttribute

Set the SCD3 effective date attribute for this attribute.

Specified by:

setSCD3EffectiveDateAttr in interface ILevelAttribute

Parameters:

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

setSCD2Type

public void setSCD2Type(OdiLevelAttribute.SCD2LevelAttributeType 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

public OdiLevelAttribute.SCD2LevelAttributeType getSCD2Type()

Description copied from interface: ILevelAttribute

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.

Specified by:

getSCD2Type in interface ILevelAttribute

Returns:

The SCD2 type.

getSCD3Type

public OdiLevelAttribute.SCD3LevelAttributeType getSCD3Type()

Description copied from interface: ILevelAttribute

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.

Specified by:

getSCD3Type in interface ILevelAttribute

Returns:

The SCD3 type.

getBoundColumn

public OdiColumn getBoundColumn()

Description copied from interface: ILevelAttribute

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.

Specified by:

getBoundColumn in interface ILevelAttribute

Returns:

The bound column.

getBoundStagingColumn

public OdiColumn getBoundStagingColumn()

Description copied from interface: ILevelAttribute

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.

Specified by:

getBoundStagingColumn in interface ILevelAttribute

Returns:

The bound staging column.

setBoundColumn

public void setBoundColumn(OdiColumn col)

Description copied from interface: ILevelAttribute

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.

Specified by:

setBoundColumn in interface ILevelAttribute

Parameters:

col - The bound column to set.

setBoundStagingColumn

public void setBoundStagingColumn(OdiColumn col)

Description copied from interface: ILevelAttribute

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.

Specified by:

setBoundStagingColumn in interface ILevelAttribute

Parameters:

col - The bound staging column to set.

isNaturalKeyAttr

public boolean isNaturalKeyAttr()

Description copied from interface: ILevelAttribute

Retrieve the natural key flag for this attribute.

Specified by:

isNaturalKeyAttr in interface ILevelAttribute

Returns:

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