oracle.odi.domain.dimension

Class OdiCube

java.lang.Object

AbstractOdiEntity

oracle.odi.domain.dimension.OdiCube

All Implemented Interfaces:

ICube, IFlexFieldUser, IModelObject, IModelObjectBase, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity

public class OdiCube
extends AbstractOdiEntity
implements IWorkDevelopmentOdiEntity, ICube, IFlexFieldUser

A class to represent a cube object.

Constructor Summary

Constructors

Constructor and Description
OdiCube(OdiDimensionalModel pModel, java.lang.String pName) Cube constructor.

Method Summary

Modifier and Type	Method and Description
void	addCubeUsesDimension(OdiCubeUsesDimension pUsesDimension) Add a cube uses dimension into this cube.
void	addMeasure(OdiMeasure pMeasure) Add a measure into this cube.
OdiMeasure	findMeasure(java.lang.String pName) Find a measure by the specified name in this cube.
OdiDataStore	getBoundDataStore() Get the bound table of this cube.
java.lang.Number	getCubeId() Returns the internal identifier of this cube.
java.util.List	getCubeUsesDimensions() Get a list of cube uses dimensions owned by this cube.
java.lang.String	getDescription() Get the description of this cube.
OdiDimensionalModel	getDimensionalModel() Get the dimensional model that contains this cube.
java.util.Collection	getFlexFieldsValues() Obtains flex fields values related to this object.
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	getMeasures() Get a list of measures owned by this cube.
java.lang.String	getName() Returns the name of this entity instance.
java.util.List	getOrderedCubeUsesDimensions() Get a list of sorted cube uses dimension.
java.util.List	getOrderedMeasures() Get a sorted list of measures owned by this cube.
IRepositoryEntity	getSecurityContainer()
boolean	hasValidationError() Check whether this cube has validation error(s).
boolean	hasValidationWarning() Check whether this cube ahs validation warning(s).
void	initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) See interface for specifics.
void	moveCubeUsesDimensionAfter(OdiCubeUsesDimension pFirstUsesDimension, OdiCubeUsesDimension pSecondUsesDimension) Move the first specified cube uses dimension to put it after the second specified cube uses dimension.
void	moveCubeUsesDimensionBefore(OdiCubeUsesDimension pFirstUsesDimension, OdiCubeUsesDimension pSecondUsesDimension) Move the first specified cube uses dimension to put it before the second specified cube uses dimension.
void	moveMeasureAfter(OdiMeasure pFirstMeasure, OdiMeasure pSecondMeasure) Move the first specified measure to put it after the second specified measure.
void	moveMeasureBefore(OdiMeasure pFirstMeasure, OdiMeasure pSecondMeasure) Move the first specified measure to put it before the second specified measure.
void	removeCubeUsesDimension(OdiCubeUsesDimension pUsesDimension) Remove the specified cube uses dimension from this cube.
void	removeMeasure(OdiMeasure pMeasure) Remove the specified measure from this cube.
void	setBoundDataStore(OdiDataStore pBoundTable) Set the bound table for this cube.
void	setDescription(java.lang.String pDescription) Set the description for this cube.
void	setName(java.lang.String pName) Set the name for this cube.
java.util.List	validate() Validate the cube.

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

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Constructor Detail

OdiCube

public OdiCube(OdiDimensionalModel pModel,
               java.lang.String pName)

Cube constructor. Creates a cube with the specified name and adds it to the specified dimensional model.

Parameters:

pModel - The dimensional model that will contain the new cube.

pName - The name of the new cube.

Method Detail

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

getCubeId

public java.lang.Number getCubeId()

Returns the internal identifier of this cube.

Returns:

The cube internal id.

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getDimensionalModel

public OdiDimensionalModel getDimensionalModel()

Description copied from interface: ICube

Get the dimensional model that contains this cube.

Specified by:

getDimensionalModel in interface ICube

Returns:

The dimensional model.

getName

public java.lang.String getName()

Description copied from interface: IOdiEntity

Returns the name of this entity instance.

Specified by:

getName in interface IFlexFieldUser

Specified by:

getName in interface IModelObject

Specified by:

getName in interface IOdiEntity

Returns:

the name

setName

public void setName(java.lang.String pName)

Description copied from interface: ICube

Set the name for this cube.

Specified by:

setName in interface ICube

Parameters:

pName - The cube name to be set.

setDescription

public void setDescription(java.lang.String pDescription)

Description copied from interface: ICube

Set the description for this cube.

Specified by:

setDescription in interface ICube

Parameters:

pDescription - The description to be set.

getDescription

public java.lang.String getDescription()

Description copied from interface: ICube

Get the description of this cube.

Specified by:

getDescription in interface ICube

Returns:

The description of this cube.

addMeasure

public void addMeasure(OdiMeasure pMeasure)

Description copied from interface: ICube

Add a measure into this cube.

Specified by:

addMeasure in interface ICube

Parameters:

pMeasure - The measure to be added.

findMeasure

public OdiMeasure findMeasure(java.lang.String pName)

Description copied from interface: ICube

Find a measure by the specified name in this cube.

Specified by:

findMeasure in interface ICube

Parameters:

pName - the measure name to search for.

Returns:

The measure with the specified name if found, else null.

removeMeasure

public void removeMeasure(OdiMeasure pMeasure)

Description copied from interface: ICube

Remove the specified measure from this cube.

Specified by:

removeMeasure in interface ICube

Parameters:

pMeasure - The measure to be removed.

getMeasures

public java.util.List getMeasures()

Description copied from interface: ICube

Get a list of measures owned by this cube. Modifying the returned list will not modify the persistent collection.

Specified by:

getMeasures in interface ICube

Returns:

A list of measures.

getOrderedMeasures

public java.util.List getOrderedMeasures()

Description copied from interface: ICube

Get a sorted list of measures owned by this cube. The measure is sorted by display order.

Specified by:

getOrderedMeasures in interface ICube

Returns:

The sorted measure list.

moveMeasureAfter

public void moveMeasureAfter(OdiMeasure pFirstMeasure,
                             OdiMeasure pSecondMeasure)

Description copied from interface: ICube

Move the first specified measure to put it after the second specified measure. If the second specified measure is null, then put the first specified measure into position 0.

Specified by:

moveMeasureAfter in interface ICube

Parameters:

pFirstMeasure - The measure to be moved.

pSecondMeasure - The after measure.

moveMeasureBefore

public void moveMeasureBefore(OdiMeasure pFirstMeasure,
                              OdiMeasure pSecondMeasure)

Description copied from interface: ICube

Move the first specified measure to put it before the second specified measure. If the second specified measure is null, then put the first specified measure into position 0.

Specified by:

moveMeasureBefore in interface ICube

Parameters:

pFirstMeasure - The measure to be moved.

pSecondMeasure - the before measure.

addCubeUsesDimension

public void addCubeUsesDimension(OdiCubeUsesDimension pUsesDimension)

Description copied from interface: ICube

Add a cube uses dimension into this cube.

Specified by:

addCubeUsesDimension in interface ICube

Parameters:

pUsesDimension - The cube uses dimension to be added.

removeCubeUsesDimension

public void removeCubeUsesDimension(OdiCubeUsesDimension pUsesDimension)

Description copied from interface: ICube

Remove the specified cube uses dimension from this cube.

Specified by:

removeCubeUsesDimension in interface ICube

Parameters:

pUsesDimension - The cube uses dimension to be removed.

getCubeUsesDimensions

public java.util.List getCubeUsesDimensions()

Description copied from interface: ICube

Get a list of cube uses dimensions owned by this cube. Modifying the returned list will not modify the persistent collection.

Specified by:

getCubeUsesDimensions in interface ICube

Returns:

A list of cube uses dimensions.

getOrderedCubeUsesDimensions

public java.util.List getOrderedCubeUsesDimensions()

Description copied from interface: ICube

Get a list of sorted cube uses dimension. The cube uses dimension is sorted by display order.

Specified by:

getOrderedCubeUsesDimensions in interface ICube

Returns:

A sorted cube uses dimension list.

moveCubeUsesDimensionAfter

public void moveCubeUsesDimensionAfter(OdiCubeUsesDimension pFirstUsesDimension,
                                       OdiCubeUsesDimension pSecondUsesDimension)

Description copied from interface: ICube

Move the first specified cube uses dimension to put it after the second specified cube uses dimension. If the second specified cube uses dimension is null, then put the first specified cube uses dimension into position 0.

Specified by:

moveCubeUsesDimensionAfter in interface ICube

Parameters:

pFirstUsesDimension - The cube uses Dimension to be moved.

pSecondUsesDimension - The after cube uses dimension.

moveCubeUsesDimensionBefore

public void moveCubeUsesDimensionBefore(OdiCubeUsesDimension pFirstUsesDimension,
                                        OdiCubeUsesDimension pSecondUsesDimension)

Description copied from interface: ICube

Move the first specified cube uses dimension to put it before the second specified cube uses dimension. If the second specified cube uses dimension is null, then put the first specified cube uses dimension into position 0.

Specified by:

moveCubeUsesDimensionBefore in interface ICube

Parameters:

pFirstUsesDimension - The cube uses Dimension to be moved.

pSecondUsesDimension - The before cube uses dimension.

getBoundDataStore

public OdiDataStore getBoundDataStore()

Description copied from interface: ICube

Get the bound table of this cube. The bound table is a datastore model that specifies where the runtime cube data will be stored.

Specified by:

getBoundDataStore in interface ICube

Returns:

The bound table.

setBoundDataStore

public void setBoundDataStore(OdiDataStore pBoundTable)

Description copied from interface: ICube

Set the bound table for this cube. The bound table is a datastore model that specifies where the runtime cube rows will be stored.

Specified by:

setBoundDataStore in interface ICube

Parameters:

pBoundTable - The bound table.

hasValidationError

public boolean hasValidationError()

Description copied from interface: ICube

Check whether this cube has validation error(s).

Specified by:

hasValidationError in interface ICube

Returns:

true if cube has validation error(s), otherwise return false.

hasValidationWarning

public boolean hasValidationWarning()

Description copied from interface: ICube

Check whether this cube ahs validation warning(s).

Specified by:

hasValidationWarning in interface ICube

Returns:

true if cube has validation warning(s), otherwise return false.

validate

public java.util.List validate()

Validate the cube. Check for referential integrity between the parts of the cube.

Returns:

A list of validation records that contain errors or warnings, if any. If no validation issues were found, an empty list is returned.

getFlexFieldsValues

public java.util.Collection getFlexFieldsValues()

Obtains flex fields values related to this object.

Method initFlexFields(IOdiFlexFieldFinder) should be called before calling this method.

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

See Also:

IFlexFieldUser.getFlexFieldsValues()

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)

See interface for specifics.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields