oracle.odi.domain.adapter.dimensional

Interface ICube

All Superinterfaces:

IModelObject, IModelObjectBase

All Known Implementing Classes:

OdiCube

public interface ICube
extends IModelObject

An interface to represent a cube object.

Method Summary

Modifier and Type	Method and Description
void	addCubeUsesDimension(ICubeUsesDimension pUsesDimension) Add a cube uses dimension into this cube.
void	addMeasure(IMeasure pMeasure) Add a measure into this cube.
IMeasure	findMeasure(java.lang.String pName) Find a measure by the specified name in this cube.
IDataStore	getBoundDataStore() Get the bound table 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.
IDimensionalModel	getDimensionalModel() Get the dimensional model that contains this cube.
java.util.List	getMeasures() Get a list of measures owned by this cube.
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.
java.lang.String	getPatternName() Get the default pattern name defined on the Cube object.
boolean	hasValidationError() Check whether this cube has validation error(s).
boolean	hasValidationWarning() Check whether this cube ahs validation warning(s).
void	moveCubeUsesDimensionAfter(ICubeUsesDimension pFirstUsesDimension, ICubeUsesDimension pSecondUsesDimension) Move the first specified cube uses dimension to put it after the second specified cube uses dimension.
void	moveCubeUsesDimensionBefore(ICubeUsesDimension pFirstUsesDimension, ICubeUsesDimension pSecondUsesDimension) Move the first specified cube uses dimension to put it before the second specified cube uses dimension.
void	moveMeasureAfter(IMeasure firstMeasure, IMeasure secondMeasure) Move the first specified measure to put it after the second specified measure.
void	moveMeasureBefore(IMeasure firstMeasure, IMeasure secondMeasure) Move the first specified measure to put it before the second specified measure.
void	removeCubeUsesDimension(ICubeUsesDimension pUsesDimension) Remove the specified cube uses dimension from this cube.
void	removeMeasure(IMeasure pMeasure) Remove the specified measure from this cube.
void	setBoundDataStore(IDataStore 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.
void	setPatternName(java.lang.String pName) Set the default pattern name defined on the Cube object.

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

getName

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

getBigNumericId, getGlobalId, getNumericId

Method Detail

getDimensionalModel

IDimensionalModel getDimensionalModel()

Get the dimensional model that contains this cube.

Returns:

The dimensional model.

setName

void setName(java.lang.String pName)

Set the name for this cube.

Parameters:

pName - The cube name to be set.

setDescription

void setDescription(java.lang.String pDescription)

Set the description for this cube.

Parameters:

pDescription - The description to be set.

getDescription

java.lang.String getDescription()

Get the description of this cube.

Returns:

The description of this cube.

addMeasure

void addMeasure(IMeasure pMeasure)

Add a measure into this cube.

Parameters:

pMeasure - The measure to be added.

removeMeasure

void removeMeasure(IMeasure pMeasure)

Remove the specified measure from this cube.

Parameters:

pMeasure - The measure to be removed.

getMeasures

java.util.List getMeasures()

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

Returns:

A list of measures.

getOrderedMeasures

java.util.List getOrderedMeasures()

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

Returns:

The sorted measure list.

moveMeasureAfter

void moveMeasureAfter(IMeasure firstMeasure,
                      IMeasure secondMeasure)

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.

Parameters:

firstMeasure - The measure to be moved.

secondMeasure - The after measure.

moveMeasureBefore

void moveMeasureBefore(IMeasure firstMeasure,
                       IMeasure secondMeasure)

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.

Parameters:

firstMeasure - The measure to be moved.

secondMeasure - the before measure.

findMeasure

IMeasure findMeasure(java.lang.String pName)

Find a measure by the specified name in this cube.

Parameters:

pName - the measure name to search for.

Returns:

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

removeCubeUsesDimension

void removeCubeUsesDimension(ICubeUsesDimension pUsesDimension)

Remove the specified cube uses dimension from this cube.

Parameters:

pUsesDimension - The cube uses dimension to be removed.

getCubeUsesDimensions

java.util.List getCubeUsesDimensions()

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

Returns:

A list of cube uses dimensions.

getOrderedCubeUsesDimensions

java.util.List getOrderedCubeUsesDimensions()

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

Returns:

A sorted cube uses dimension list.

addCubeUsesDimension

void addCubeUsesDimension(ICubeUsesDimension pUsesDimension)

Add a cube uses dimension into this cube.

Parameters:

pUsesDimension - The cube uses dimension to be added.

moveCubeUsesDimensionAfter

void moveCubeUsesDimensionAfter(ICubeUsesDimension pFirstUsesDimension,
                                ICubeUsesDimension pSecondUsesDimension)

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.

Parameters:

pFirstUsesDimension - The cube uses Dimension to be moved.

pSecondUsesDimension - The after cube uses dimension.

moveCubeUsesDimensionBefore

void moveCubeUsesDimensionBefore(ICubeUsesDimension pFirstUsesDimension,
                                 ICubeUsesDimension pSecondUsesDimension)

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.

Parameters:

pFirstUsesDimension - The cube uses Dimension to be moved.

pSecondUsesDimension - The before cube uses dimension.

getBoundDataStore

IDataStore getBoundDataStore()

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

Returns:

The bound table.

setBoundDataStore

void setBoundDataStore(IDataStore pBoundTable)

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

Parameters:

pBoundTable - The bound table.

hasValidationError

boolean hasValidationError()

Check whether this cube has validation error(s).

Returns:

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

hasValidationWarning

boolean hasValidationWarning()

Check whether this cube ahs validation warning(s).

Returns:

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

getPatternName

java.lang.String getPatternName()

Get the default pattern name defined on the Cube object.

Returns:

setPatternName

void setPatternName(java.lang.String pName)

Set the default pattern name defined on the Cube object.