oracle.odi.domain.adapter.dimensional

Interface IDimension

All Superinterfaces:

IModelObject, IModelObjectBase

All Known Implementing Classes:

OdiDimension

public interface IDimension
extends IModelObject

Method Summary

Modifier and Type	Method and Description
IHierarchy	findHierarchy(java.lang.String hierName) Find a hierarchy with the specified name in this dimension.
IDataStore	getBoundDataStore() Get the bound data store for this dimension.
ISequence	getBoundSequence() Get the bound sequence for this dimension.
IHierarchy	getDefaultHierarchy() Get the default hierarchy for this dimension.
java.lang.String	getDescription() Get the description for this dimension.
IDimensionalModel	getDimensionalModel() Get the dimensional model that contains this dimension.
java.util.List	getHierarchies() Get the list of hierarchies owned by this dimension.
java.util.List	getLevels() Get The list of levels owned by this dimension.
java.util.List	getLevelsOrderedByPosition() Get The list of levels, sorted by display order.
java.util.List	getLevelsOrderedForLoading() Get the levels sorted by hierarchical order, from top to bottom.
java.lang.String	getName() Get the name of this dimension.
java.util.List	getOrderedHierarchies() Get a copy of the hierarchies list, sorted by display order.
java.lang.String	getPatternName() Get the default pattern name defined on the dimension object.
boolean	hasValidationError() Get whether this dimension has validation error.
boolean	hasValidationWarning() Get whether this dimension has validation warning.
void	moveHierarchyAfter(IHierarchy hier, IHierarchy baseHier) Move the specified hierarchy to put it after the specified base hierarchy.
void	moveLevelAfter(ILevel level, ILevel baseLevel) Reorder the specified level to put it after the specified base level.
void	removeHierarchy(IHierarchy hier) Remove a hierarchy from this dimension.
void	removeLevel(ILevel lev) Remove the specified level from this dimension.
void	setBoundDataStore(IDataStore ds) Set the bound data store for this dimension.
void	setBoundSequence(ISequence seq) Set the bound sequence for this dimension.
void	setDefaultHierarchy(IHierarchy h) Set one particular hierarchy among the hierarchies of this dimension to be the default hierarchy.
void	setDescription(java.lang.String desc) Set the description of this dimension.
void	setName(java.lang.String dimName) Set the name of this dimension.

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

getBigNumericId, getGlobalId, getNumericId

Method Detail

getDimensionalModel

IDimensionalModel getDimensionalModel()

Get the dimensional model that contains this dimension.

getName

java.lang.String getName()

Get the name of this dimension.

Specified by:

getName in interface IModelObject

Returns:

the name of the dimension.

setName

void setName(java.lang.String dimName)

Set the name of this dimension.

Parameters:

dimName - The name to set.

setDescription

void setDescription(java.lang.String desc)

Set the description of this dimension.

Parameters:

desc - The description to set.

getDescription

java.lang.String getDescription()

Get the description for this dimension.

getLevels

java.util.List getLevels()

Get The list of levels owned by this dimension. Modifying the returned list will not modify the persistent collection.

Returns:

the list of levels.

getLevelsOrderedByPosition

java.util.List getLevelsOrderedByPosition()

Get The list of levels, sorted by display order. Modifying the returned list will not modify the persistent collection.

Returns:

the sorted list of levels.

getLevelsOrderedForLoading

java.util.List getLevelsOrderedForLoading()

Get the levels sorted by hierarchical order, from top to bottom. The existing parent ref objects are used to determine the hierarchical order. An exception is thrown if the parent ref order established in one hierarchy contradicts the parent ref order established by another hierarchy. If no correct hierarchy order can be calculated, then the levels are returned sorted by display order.

Returns:

the list of ordered levels.

removeLevel

void removeLevel(ILevel lev)

Remove the specified level from this dimension.

Parameters:

lev - The level to be removed.

moveLevelAfter

void moveLevelAfter(ILevel level,
                    ILevel baseLevel)

Reorder the specified level to put it after the specified base level. If the base level is null, then put the specified level into position 0.

Parameters:

level - The level to reorder.

baseLevel - The base level. If null, the reordered level will be put first.

getOrderedHierarchies

java.util.List getOrderedHierarchies()

Get a copy of the hierarchies list, sorted by display order. Modifying the returned list will not change the persistent list owned by this dimension.

Returns:

The sorted hierarchy list.

getHierarchies

java.util.List getHierarchies()

Get the list of hierarchies owned by this dimension. Modifying the returned list will not change the persistent list owned by this dimension.

Returns:

The hierarchy list.

moveHierarchyAfter

void moveHierarchyAfter(IHierarchy hier,
                        IHierarchy baseHier)

Move the specified hierarchy to put it after the specified base hierarchy. If the base hierarchy is null, then put the specified hierarchy into position 0.

Parameters:

hier - The hierarchy to reorder.

baseHier - The base hierarchy. If null, the reordered hierarchy will be put first.

removeHierarchy

void removeHierarchy(IHierarchy hier)

Remove a hierarchy from this dimension.

Parameters:

hier - The hierarchy to remove.

findHierarchy

IHierarchy findHierarchy(java.lang.String hierName)

Find a hierarchy with the specified name in this dimension. If not found, return null.

Parameters:

hierName - The hierarchy name to search for.

Returns:

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

getBoundDataStore

IDataStore getBoundDataStore()

Get the bound data store for this dimension. The bound data store is a datastore model that specifies where the runtime dimension data will be stored. Only applicable for a star implementation.

Returns:

the data store.

setBoundDataStore

void setBoundDataStore(IDataStore ds)

Set the bound data store for this dimension. The bound data store is a datastore model that specifies where the runtime dimension rows will be stored. Only applicable for a star implementation.

Parameters:

ds - The bound data store model.

setBoundSequence

void setBoundSequence(ISequence seq)

Set the bound sequence for this dimension. The bound sequence is a sequence model that specifies the sequence that will be used to generate surrogate ids for the runtime dimension and level data. This is used whenever surrogate id generation is enabled, for a star or snowflake implementation.

Parameters:

seq - The bound sequence model.

getBoundSequence

ISequence getBoundSequence()

Get the bound sequence for this dimension. The bound sequence is a sequence model that will be used to generate surrogate ids for the runtime dimension and level data. This is used whenever surrogate id generation is enabled, for a star or snowflake implementation.

Returns:

The bound sequence model.

setDefaultHierarchy

void setDefaultHierarchy(IHierarchy h)

Set one particular hierarchy among the hierarchies of this dimension to be the default hierarchy. The default hierarchy is the one that will be displayed by default when displaying the dimension data or when running reports against the dimension. Only one hierarchy can be set as the default. If another hierarchy is already set as the default when this is called, then the other hierarchy will no longer be the default hierarchy.

Parameters:

h - The hierarchy that will be set as the default hierarchy.

getDefaultHierarchy

IHierarchy getDefaultHierarchy()

Get the default hierarchy for this dimension. The default hierarchy is the one that will be displayed by default when displaying the dimension data or when running reports against the dimension. Only one hierarchy can be set as the default. If another hierarchy is already set as the default when this is called, then the other hierarchy will no longer be the default hierarchy.

Returns:

The default hierarchy.

hasValidationError

boolean hasValidationError()

Get whether this dimension has validation error.

Returns:

hasValidationWarning

boolean hasValidationWarning()

Get whether this dimension has validation warning.

Returns:

getPatternName

java.lang.String getPatternName()

Get the default pattern name defined on the dimension object.

Returns: