oracle.odi.domain.dimension

Class OdiMeasure

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.dimension.OdiMeasure

All Implemented Interfaces:

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

public class OdiMeasure
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IMeasure

A class to represent a cube measure.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OdiMeasure(OdiCube pCube, java.lang.String pName) OdiMeasure constructor.
OdiMeasure(OdiCube pCube, java.lang.String pName, OdiDataType pDataType) OdiMeasure constructor.
OdiMeasure(OdiCube pCube, java.lang.String pName, OdiDataType pDataType, java.lang.Integer pLength) OdiMeasure constructor.
OdiMeasure(OdiCube pCube, java.lang.String pName, OdiDataType pDataType, java.lang.Integer pLength, java.lang.Integer pScale) OdiMeasure constructor.

Method Summary

Modifier and Type	Method and Description
OdiColumn	getBoundColumn() Get the bound column for this measure.
OdiCube	getCube() Get the owning cube of this measure.
OdiDataType	getDataType() Get the data type that is associated with this measure.
java.lang.String	getDescription() Get the description of this measure
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.lang.Number	getMeasureId() Returns the internal identifier of this measure.
java.lang.String	getName() Gets the name of this model object.
int	getPosition() Get the position of this measure in its owning cube.
java.lang.Integer	getScale() Get the scale of this measure.
java.lang.Integer	getSize() Get the the size (length or precision) of this measure.
void	setBoundColumn(OdiColumn pBoundColumn) Set the bound column for this measure.
void	setDataType(OdiDataType pDataType) Set the data type that is associated with this measure.
void	setDescription(java.lang.String pDescription) Set the description for this measure.
void	setName(java.lang.String pName) Set the name for this measure.
void	setScale(java.lang.Integer pScale) Set the scale for this measure.
void	setSize(java.lang.Integer pSize) Set the size for this measure.

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode, toString

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

OdiMeasure

public OdiMeasure(OdiCube pCube,
                  java.lang.String pName)

OdiMeasure constructor. The data type, size, scale will all be set to null.

Parameters:

pCube - The owning cube for this measure. It cannot be null.

pName - The name of the measure.

OdiMeasure

public OdiMeasure(OdiCube pCube,
                  java.lang.String pName,
                  OdiDataType pDataType)

OdiMeasure constructor.

Parameters:

pCube - The owning cube for this measure. It cannot be null.

pName - The name of the measure.

pDataType - The measure data type. It must be a data type owned by the generic technology.

OdiMeasure

public OdiMeasure(OdiCube pCube,
                  java.lang.String pName,
                  OdiDataType pDataType,
                  java.lang.Integer pLength)

OdiMeasure constructor.

Parameters:

pCube - The owning cube for this measure. It cannot be null.

pName - The name of the measure.

pDataType - The measure data type. It must be a data type owned by the generic technology.

pLength - The data length/precision or size for the measure. It can be set to null if size is not applicable for the data type.

OdiMeasure

public OdiMeasure(OdiCube pCube,
                  java.lang.String pName,
                  OdiDataType pDataType,
                  java.lang.Integer pLength,
                  java.lang.Integer pScale)

OdiMeasure constructor.

Parameters:

pCube - The owning cube for this measure. It cannot be null.

pName - The name of the measure.

pDataType - The measure data type. It must be a data type owned by the generic technology.

pLength - The data length/precision or size for the measure. It can be set to null if size is not applicable for the data type.

pScale - The data scale for the measure. It can be set to null if scale is not applicable for the data type.

Method Detail

setName

public void setName(java.lang.String pName)

Description copied from interface: IMeasure

Set the name for this measure.

Specified by:

setName in interface IMeasure

Parameters:

pName - The name for this measure.

getName

public java.lang.String getName()

Description copied from interface: IModelObject

Gets the name of this model object.

Specified by:

getName in interface IModelObject

Returns:

name of this object

setDescription

public void setDescription(java.lang.String pDescription)

Description copied from interface: IMeasure

Set the description for this measure.

Specified by:

setDescription in interface IMeasure

Parameters:

pDescription - The description for this measure.

getDescription

public java.lang.String getDescription()

Description copied from interface: IMeasure

Get the description of this measure

Specified by:

getDescription in interface IMeasure

Returns:

The description of this measure.

getPosition

public int getPosition()

Description copied from interface: IMeasure

Get the position of this measure in its owning cube. The position number is used for display purposes.

Specified by:

getPosition in interface IMeasure

Returns:

The position of this measure.

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

getMeasureId

public java.lang.Number getMeasureId()

Returns the internal identifier of this measure.

Returns:

The measure internal id.

getDataType

public OdiDataType getDataType()

Description copied from interface: IMeasure

Get the data type that is associated with this measure. The data type is assumed to exist in the generic technology model for the repository.

Specified by:

getDataType in interface IMeasure

Returns:

The Data type of this measure.

setDataType

public void setDataType(OdiDataType pDataType)

Description copied from interface: IMeasure

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

Specified by:

setDataType in interface IMeasure

Parameters:

pDataType - the data type to set for this measure.

getSize

public java.lang.Integer getSize()

Description copied from interface: IMeasure

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

Specified by:

getSize in interface IMeasure

Returns:

The size of this measure.

setSize

public void setSize(java.lang.Integer pSize)

Description copied from interface: IMeasure

Set the size for this measure. The size is used to validate the size of the bound column at validation or code generation time.

Specified by:

setSize in interface IMeasure

Parameters:

pSize - The size for this measure, or null if not applicable.

getScale

public java.lang.Integer getScale()

Description copied from interface: IMeasure

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

Specified by:

getScale in interface IMeasure

Returns:

The scale of this measure.

setScale

public void setScale(java.lang.Integer pScale)

Description copied from interface: IMeasure

Set the scale for this measure. The scale is used to validate the scale of the bound column at validation or code generation time.

Specified by:

setScale in interface IMeasure

Parameters:

pScale - The scale for this measure, or null if not applicable.

getCube

public OdiCube getCube()

Description copied from interface: IMeasure

Get the owning cube of this measure.

Specified by:

getCube in interface IMeasure

Returns:

The owning cube.

getBoundColumn

public OdiColumn getBoundColumn()

Description copied from interface: IMeasure

Get the bound column for this measure. The bound column is a column in the cube bound table that corresponds to this measure. The runtime data for this measure will be stored in the bound column.

Specified by:

getBoundColumn in interface IMeasure

Returns:

The bound column for this measure.

setBoundColumn

public void setBoundColumn(OdiColumn pBoundColumn)

Description copied from interface: IMeasure

Set the bound column for this measure. The bound column is a column in the cube bound table that corresponds to this measure. The runtime data for this measure will be stored in the bound column.

Specified by:

setBoundColumn in interface IMeasure

Parameters:

pBoundColumn - The bound column for this measure.