com.tibco.rta
Interface MetricKey

All Superinterfaces:

java.lang.Comparable, Key, java.io.Serializable

public interface MetricKey
extends Key

Each computed metric has a unique key identified by its dimension values.

Method Summary

void	addDimensionValueToKey(java.lang.String dimensionName, java.lang.Object dimensionValue) Adds a dimension value to the key.
java.lang.String	getCubeName() The associated cube name.
java.lang.String	getDimensionHierarchyName() The associated hierarchy name.
java.lang.String	getDimensionLevelName() The associated dimension level name.
java.util.List<java.lang.String>	getDimensionNames() Return the list of dimension names.
java.lang.Object	getDimensionValue(java.lang.String dimensionName) Get the associated dimension value/
java.lang.String	getSchemaName() The associated schema name.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getSchemaName

java.lang.String getSchemaName()

The associated schema name.

Returns:

the associated schema name.

getCubeName

java.lang.String getCubeName()

The associated cube name.

Returns:

he associated cube name.

getDimensionHierarchyName

java.lang.String getDimensionHierarchyName()

The associated hierarchy name.

Returns:

the associated hierarchy name.

getDimensionLevelName

java.lang.String getDimensionLevelName()

The associated dimension level name.

Returns:

the associated dimension level name.

getDimensionNames

java.util.List<java.lang.String> getDimensionNames()

Return the list of dimension names.

Returns:

the list of dimension names.

getDimensionValue

java.lang.Object getDimensionValue(java.lang.String dimensionName)

Get the associated dimension value/

Parameters:

dimensionName - name for which value is desired.

Returns:

the associated dimension value.

addDimensionValueToKey

void addDimensionValueToKey(java.lang.String dimensionName,
                            java.lang.Object dimensionValue)

Adds a dimension value to the key. Key comprises of key/value pairs. This method is used to build the entire key from its constitient key/values.

Parameters:

dimensionName - the dimension name.

dimensionValue - its associated value.