com.tibco.rta.model.mutable
Interface MutableDimensionHierarchy

All Superinterfaces:

DimensionHierarchy, MetadataElement, MutableMetadataElement, java.io.Serializable

public interface MutableDimensionHierarchy
extends MutableMetadataElement, DimensionHierarchy

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

Method Summary

void	addDimensionAfter(Dimension refDimension, Dimension newDimension) Inserts new dimension after the reference dimension.
void	addExcludeMeasurement(Dimension dimension, Measurement measurement) Add a measurement to exclude from being computed for this dimension.
void	addMeasurement(MutableMeasurement measurement)
Dimension	removeDimension(java.lang.String name) Removes the dimension.
void	removeExcludeMeasurement(Dimension dimension, Measurement measurement) Remove a previously set exclude measurement.
void	removeMeasurement(Measurement measurement) Remove a measurement from this hierarchy.
void	setComputeForLevel(Dimension dimension, boolean toCompute) Sets the computation status for a given dimension.
void	setEnabled(boolean isEnabled) enable computation for this hierarchy
void	setRetentionPolicy(RetentionPolicy retentionPolicy) Set a retention policy for this hierarchy.
void	setRootDimension(Dimension dimension) Set root dimension for the hierarchy.

Methods inherited from interface com.tibco.rta.model.mutable.MutableMetadataElement

setDescription, setDisplayName, setName, setProperty

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

computeRoot, getComputeForLevel, getDepth, getDimension, getDimension, getDimensionAttribNames, getDimensions, getExcludedMeasurements, getExcludedMeasurements, getLevel, getMeasurement, getMeasurements, getMeasurementsForLevel, getOwnerCube, getRetentionPolicy, isEnabled, isExcluded

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

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

Method Detail

addDimensionAfter

void addDimensionAfter(Dimension refDimension,
                       Dimension newDimension)
                       throws IllegalSchemaException

Inserts new dimension after the reference dimension.

Parameters:

refDimension - the dimension to add new dimension after. It can take a null value. If null and no dimensions exist, it is same as setRootDimension(Dimension) else throw IllegalArgumentException

newDimension - the new dimension to add.

Throws:

IllegalSchemaException - If the owner schema of this hierarchy and the child dimension are different

java.lang.IllegalArgumentException - If the new child and the reference dimension are equal.

java.lang.IllegalArgumentException - If refDimension is null and hierarchy is not empty

removeDimension

Dimension removeDimension(java.lang.String name)
                          throws IllegalSchemaException

Removes the dimension.

Parameters:

dimElement - the dim element

Throws:

IllegalSchemaException

setRootDimension

void setRootDimension(Dimension dimension)

Set root dimension for the hierarchy. If a root exists, it will be overwritten with the new one.

Parameters:

dimension - the root dimension.

addMeasurement

void addMeasurement(MutableMeasurement measurement)
                    throws UndefinedSchemaElementException,
                           DuplicateSchemaElementException

Parameters:

measurement -

Throws:

UndefinedSchemaElementException

DuplicateSchemaElementException

removeMeasurement

void removeMeasurement(Measurement measurement)

Remove a measurement from this hierarchy.

Parameters:

measurement - the measurement to remove.

addExcludeMeasurement

void addExcludeMeasurement(Dimension dimension,
                           Measurement measurement)

Add a measurement to exclude from being computed for this dimension.

Parameters:

dimension - the dimension for which to exclude computation of a measurement.

measurement - the associated measurement to exclude.

removeExcludeMeasurement

void removeExcludeMeasurement(Dimension dimension,
                              Measurement measurement)

Remove a previously set exclude measurement.

Parameters:

dimension - the dimension for which to remove the exclude computation of a measurement.

measurement - the associated measurement to exclude.

setComputeForLevel

void setComputeForLevel(Dimension dimension,
                        boolean toCompute)

Sets the computation status for a given dimension. If false, will not compute the metric for this dimension.

Parameters:

dimension - the dimension for which to not compute measurements.

toCompute - set to false if you do not wich to compute measurements for this dimension.

setRetentionPolicy

void setRetentionPolicy(RetentionPolicy retentionPolicy)

Set a retention policy for this hierarchy.

Parameters:

retentionPolicy - the retention policy to set for this hierarchy.

setEnabled

void setEnabled(boolean isEnabled)

enable computation for this hierarchy

Parameters:

isEnabled - is false if computation for this hierarchy is disabled