com.essbase.api.dataquery

Interface IEssMdCluster

All Superinterfaces:

IEssBaseObject

public interface IEssMdCluster
extends IEssBaseObject

The IEssMdCluster interface.

Version:

1.0, 04/09/2004

Author:

Abhijeet Katariya

Method Summary

Modifier and Type	Method and Description
IEssMdMember[]	getAllDimensionMembers(int dimensionIndex) Returns an array of this cluster's members at for a given dimension.
IEssMdMember[]	getAllTupleMembers(int tupleIndex) Returns an array of this cluster's tuple members at a given cluster tuple index.
int	getDimensionCount() Gets the number of dimensions in this cluster.
int	getTupleCount() Gets the number of tuples in this cluster.

Method Detail

getTupleCount

int getTupleCount()
           throws com.essbase.api.base.EssException

Gets the number of tuples in this cluster.

Returns:

The number of tuples in this cluster.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getDimensionCount

int getDimensionCount()
               throws com.essbase.api.base.EssException

Gets the number of dimensions in this cluster.

Returns:

Number of dimensions in this cluster.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getAllTupleMembers

IEssMdMember[] getAllTupleMembers(int tupleIndex)
                           throws com.essbase.api.base.EssException

Returns an array of this cluster's tuple members at a given cluster tuple index.

Parameters:

tupleIndex - The tuple index for which to get the members.

Returns:

An array of IEssMdMember interface.

Throws:

com.essbase.api.base.EssException - if an error occurs.

getAllDimensionMembers

IEssMdMember[] getAllDimensionMembers(int dimensionIndex)
                               throws com.essbase.api.base.EssException

Returns an array of this cluster's members at for a given dimension.

Parameters:

dimensionIndex - The dimension index for which to get the members.

Returns:

An array of IEssMdMember interface.

Throws:

com.essbase.api.base.EssException - if an error occurs.