com.tibco.rta.model
Interface DimensionHierarchy

All Superinterfaces:

MetadataElement, java.io.Serializable

All Known Subinterfaces:

MutableDimensionHierarchy

public interface DimensionHierarchy
extends MetadataElement

This defines the hierarchy of Dimensions on which aggregations should be performed

Method Summary

boolean	computeRoot() Returns true if the root computation of all nodes is required.
boolean	getComputeForLevel(int level) Returns true if computation is desired at this level.
int	getDepth() Return the entire length of hierarchy.
Dimension	getDimension(int level) Return the dimension at the specified level in the hierarchy
Dimension	getDimension(java.lang.String dimName) Returns the dimension associated with the name.
java.util.Collection<java.lang.String>	getDimensionAttribNames() Returns an ordered list of attribute names corresponding to its ordered dimensions.
<T extends Dimension> java.util.Collection<T>	getDimensions() Return the ordered list of dimensions in this hierarchy.
<T extends Measurement> java.util.Collection<T>	getExcludedMeasurements(Dimension dimension) Returns a collection of excluded measurements for a given dimension.
<T extends Measurement> java.util.Collection<T>	getExcludedMeasurements(int level) Returns a collection of excluded measurements for a given level.
int	getLevel(java.lang.String dimensionNm) Return level for a dimension.
<T extends Measurement> T	getMeasurement(java.lang.String name) Return the associated measurement for this hierarchy.
<T extends Measurement> java.util.Collection<T>	getMeasurements() Return the associated measurements for this hierarchy.
java.util.Collection<Measurement>	getMeasurementsForLevel(int level) Return a collection of measurements for a given level.
<T extends Cube> T	getOwnerCube() Gets the owning cube for this hierarchy
RetentionPolicy	getRetentionPolicy() Return the associated retention policy for this dimension.
boolean	isEnabled() Is computation for this hierarchy is enabled/ disabled ? If false, its disabled
boolean	isExcluded(int level, java.lang.String measurementName) Returns true if measurement is excluded at this dimension level

Methods inherited from interface com.tibco.rta.model.MetadataElement

getDescription, getDisplayName, getName, getOwnerSchema, getProperty, getPropertyNames, serialize

Method Detail

getOwnerCube

<T extends Cube> T getOwnerCube()

Gets the owning cube for this hierarchy

Returns:

a cube instance

getDimension

Dimension getDimension(int level)

Return the dimension at the specified level in the hierarchy

Parameters:

level -

Returns:

the dimension at this level

getDimensions

<T extends Dimension> java.util.Collection<T> getDimensions()

Return the ordered list of dimensions in this hierarchy.

Returns:

the ordered list of dimensions in this hierarchy.

getLevel

int getLevel(java.lang.String dimensionNm)

Return level for a dimension.

Parameters:

dimensionNm - The dimension for which to obtain the level in the hierarchy. The topmost level is 0.

Returns:

the Level associated with the dimension

getDepth

int getDepth()

Return the entire length of hierarchy.

Returns:

the total number of dimensions in hierarchy.

getMeasurement

<T extends Measurement> T getMeasurement(java.lang.String name)

Return the associated measurement for this hierarchy.

Parameters:

name - name of the measurement.

getMeasurements

<T extends Measurement> java.util.Collection<T> getMeasurements()

Return the associated measurements for this hierarchy.

getExcludedMeasurements

<T extends Measurement> java.util.Collection<T> getExcludedMeasurements(int level)

Returns a collection of excluded measurements for a given level.

Parameters:

level - Level for which to obtain the excluded measurements.

Returns:

a collection of excluded measurements for a given level.

getExcludedMeasurements

<T extends Measurement> java.util.Collection<T> getExcludedMeasurements(Dimension dimension)

Returns a collection of excluded measurements for a given dimension.

Parameters:

dimension - Dimension for which to obtain the excluded measurements.

Returns:

a collection of excluded measurements for a given dimension.

getDimension

Dimension getDimension(java.lang.String dimName)

Returns the dimension associated with the name.

Parameters:

dimName - the dimension name for which to obtain the dimension

Returns:

the associated dimension.

computeRoot

boolean computeRoot()

Returns true if the root computation of all nodes is required.

Returns:

true if the root computation of all nodes is required, false otherwise.

getMeasurementsForLevel

java.util.Collection<Measurement> getMeasurementsForLevel(int level)

Return a collection of measurements for a given level.

Parameters:

level - Level for which to obtain measurements.

Returns:

a collection of measurements for a given level.

getComputeForLevel

boolean getComputeForLevel(int level)

Returns true if computation is desired at this level.

Parameters:

level - the level for which to obtain its compute setting.

Returns:

true if to compute measurements at this level, false otherwise.

getRetentionPolicy

RetentionPolicy getRetentionPolicy()

Return the associated retention policy for this dimension.

Returns:

the associated retention policy for this dimension.

isEnabled

boolean isEnabled()

Is computation for this hierarchy is enabled/ disabled ? If false, its disabled

Returns:

false if its disabled.

isExcluded

boolean isExcluded(int level,
                   java.lang.String measurementName)

Returns true if measurement is excluded at this dimension level

Parameters:

level - Level for which to obtain the excluded measurements.

Returns:

name of measurement

getDimensionAttribNames

java.util.Collection<java.lang.String> getDimensionAttribNames()

Returns an ordered list of attribute names corresponding to its ordered dimensions.

Returns:

a list of ordered attribute names