oracle.odi.domain.dimension

Class OdiDimension

java.lang.Object

AbstractOdiEntity

oracle.odi.domain.dimension.OdiDimension

All Implemented Interfaces:

IDimension, IFlexFieldUser, IModelObject, IModelObjectBase, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity

public class OdiDimension
extends AbstractOdiEntity
implements IWorkDevelopmentOdiEntity, IDimension, IFlexFieldUser

A class to represent a dimension object.

Constructor Summary

Constructors

Constructor and Description
OdiDimension(OdiDimensionalModel dimModel, java.lang.String dimName) Dimension constructor.

Method Summary

Modifier and Type	Method and Description
void	addHierarchy(OdiHierarchy hier) Add a hierarchy to this level.
void	addLevel(OdiLevel level) Add a level to this dimension.
OdiHierarchy	findHierarchy(java.lang.String hierName) Find a hierarchy with the specified name in this dimension.
OdiDataStore	getBoundDataStore() Get the bound data store for this dimension.
ISequence	getBoundSequence() Get the bound sequence for this dimension.
OdiHierarchy	getDefaultHierarchy() Get the default hierarchy for this dimension.
java.lang.String	getDescription() Get the description for this dimension.
OdiDimensionalModel	getDimensionalModel() Get the dimensional model that contains this dimension.
java.lang.Number	getDimensionId() Get the internal unique id for this dimension object.
java.util.Collection	getFlexFieldsValues() Obtains flex fields values related to this object.
java.util.List	getHierarchies() Get the list of hierarchies owned by this dimension.
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	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() Returns the name of this entity instance.
java.util.List	getOrderedHierarchies() Get a copy of the hierarchies list, sorted by display order.
IRepositoryEntity	getSecurityContainer()
boolean	hasValidationError() Get whether this dimension has validation error.
boolean	hasValidationWarning() Get whether this dimension has validation warning.
void	initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) See interface for specifics.
void	moveHierarchyAfter(OdiHierarchy hier, OdiHierarchy baseHier) Move the specified hierarchy to put it after the specified base hierarchy.
void	moveLevelAfter(OdiLevel level, OdiLevel baseLevel) Reorder the specified level to put it after the specified base level.
void	removeHierarchy(OdiHierarchy hier) Remove a hierarchy from this dimension.
void	removeLevel(OdiLevel lev) Remove the specified level from this dimension.
void	setBoundDataStore(OdiDataStore ds) Set the bound data store for this dimension.
void	setBoundSequence(OdiSequence seq) Set the bound sequence for this dimension.
void	setDefaultHierarchy(OdiHierarchy 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.
java.util.List	validate() Validate the dimension.
boolean	validateHierarchies() Return true if the hierarchies in this dimension are valid.

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

OdiDimension

public OdiDimension(OdiDimensionalModel dimModel,
                    java.lang.String dimName)

Dimension constructor. Creates a dimension with the specified name and adds it to the specified dimensional model.

Parameters:

dimModel - The dimensional model that will contain the new dimension.

dimName - The name of the new dimension.

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

getDimensionId

public java.lang.Number getDimensionId()

Get the internal unique id for this dimension object. It is unique among all dimension objects in this repository.

Returns:

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getDimensionalModel

public OdiDimensionalModel getDimensionalModel()

Description copied from interface: IDimension

Get the dimensional model that contains this dimension.

Specified by:

getDimensionalModel in interface IDimension

getName

public java.lang.String getName()

Description copied from interface: IOdiEntity

Returns the name of this entity instance.

Specified by:

getName in interface IDimension

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 dimName)

Description copied from interface: IDimension

Set the name of this dimension.

Specified by:

setName in interface IDimension

Parameters:

dimName - The name to set.

setDescription

public void setDescription(java.lang.String desc)

Description copied from interface: IDimension

Set the description of this dimension.

Specified by:

setDescription in interface IDimension

Parameters:

desc - The description to set.

getDescription

public java.lang.String getDescription()

Description copied from interface: IDimension

Get the description for this dimension.

Specified by:

getDescription in interface IDimension

getLevelsOrderedByPosition

public java.util.List getLevelsOrderedByPosition()

Description copied from interface: IDimension

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

Specified by:

getLevelsOrderedByPosition in interface IDimension

Returns:

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

getLevels

public java.util.List getLevels()

Description copied from interface: IDimension

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

Specified by:

getLevels in interface IDimension

Returns:

The collection of levels. Modifying the returned list will not modify the persistent collection.

getLevelsOrderedForLoading

public 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.

Specified by:

getLevelsOrderedForLoading in interface IDimension

Returns:

the list of ordered levels.

validateHierarchies

public boolean validateHierarchies()

Return true if the hierarchies in this dimension are valid. The hierarchies are valid if the level order for each hierarchy does not contradict the level order for any other hierarchy.

Returns:

addLevel

public void addLevel(OdiLevel level)

Add a level to this dimension.

Parameters:

level - The level to add.

removeLevel

public void removeLevel(OdiLevel lev)

Description copied from interface: IDimension

Remove the specified level from this dimension.

Specified by:

removeLevel in interface IDimension

Parameters:

lev - The level to be removed.

moveLevelAfter

public void moveLevelAfter(OdiLevel level,
                           OdiLevel 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.

Specified by:

moveLevelAfter in interface IDimension

Parameters:

level - The level to reorder.

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

getHierarchies

public java.util.List getHierarchies()

Description copied from interface: IDimension

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

Specified by:

getHierarchies in interface IDimension

Returns:

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

getOrderedHierarchies

public java.util.List getOrderedHierarchies()

Description copied from interface: IDimension

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.

Specified by:

getOrderedHierarchies in interface IDimension

Returns:

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

addHierarchy

public void addHierarchy(OdiHierarchy hier)

Add a hierarchy to this level.

Parameters:

hier - The hierarchy to add.

moveHierarchyAfter

public void moveHierarchyAfter(OdiHierarchy hier,
                               OdiHierarchy 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.

Specified by:

moveHierarchyAfter in interface IDimension

Parameters:

hier - The hierarchy to reorder.

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

removeHierarchy

public void removeHierarchy(OdiHierarchy hier)

Description copied from interface: IDimension

Remove a hierarchy from this dimension.

Specified by:

removeHierarchy in interface IDimension

Parameters:

hier - The hierarchy to remove.

findHierarchy

public OdiHierarchy findHierarchy(java.lang.String hierName)

Description copied from interface: IDimension

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

Specified by:

findHierarchy in interface IDimension

Parameters:

hierName - The hierarchy name to search for.

Returns:

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

getBoundDataStore

public OdiDataStore getBoundDataStore()

Description copied from interface: IDimension

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.

Specified by:

getBoundDataStore in interface IDimension

Returns:

the data store.

setBoundDataStore

public void setBoundDataStore(OdiDataStore ds)

Description copied from interface: IDimension

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.

Specified by:

setBoundDataStore in interface IDimension

Parameters:

ds - The bound data store model.

setBoundSequence

public void setBoundSequence(OdiSequence seq)

Description copied from interface: IDimension

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.

Specified by:

setBoundSequence in interface IDimension

Parameters:

seq - The bound sequence model.

getBoundSequence

public ISequence getBoundSequence()

Description copied from interface: IDimension

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.

Specified by:

getBoundSequence in interface IDimension

Returns:

The bound sequence model.

setDefaultHierarchy

public void setDefaultHierarchy(OdiHierarchy h)

Description copied from interface: IDimension

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.

Specified by:

setDefaultHierarchy in interface IDimension

Parameters:

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

getDefaultHierarchy

public OdiHierarchy getDefaultHierarchy()

Description copied from interface: IDimension

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.

Specified by:

getDefaultHierarchy in interface IDimension

Returns:

The default hierarchy.

validate

public java.util.List validate()

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

Returns:

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

hasValidationError

public boolean hasValidationError()

Description copied from interface: IDimension

Get whether this dimension has validation error.

Specified by:

hasValidationError in interface IDimension

Returns:

hasValidationWarning

public boolean hasValidationWarning()

Description copied from interface: IDimension

Get whether this dimension has validation warning.

Specified by:

hasValidationWarning in interface IDimension

Returns:

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