com.essbase.api.dataquery

Interface IEssMdAxis

All Superinterfaces:

IEssBaseObject

public interface IEssMdAxis
extends IEssBaseObject

The IEssMdAxis interface. This represents an axis in the multi-dimensional result set returned by an MDX query operation.

Version:

1.0, 04/09/2004

Author:

Abhijeet Katariya

Method Summary

Modifier and Type	Method and Description
IEssMdCluster[]	getAllClusters() Returns an array of all the clusters in this axis.
IEssMdMember[]	getAllDimensions() Returns an array of all dimensions in this axis.
IEssMdMember[]	getAllTupleMembers(int tupleIndex) Returns an array of this axis's tuple members at a given tuple index.
int	getClusterCount() Gets the number of clusters in this axis.
int	getDimensionCount() Gets the number of dimensions in this axis.
int	getTupleCount() Gets the number of tuples in this axis.
boolean	isSlicerAxis() Checks if this axis is a slicer axis.

Method Detail

isSlicerAxis

boolean isSlicerAxis()
              throws com.essbase.api.base.EssException

Checks if this axis is a slicer axis.

Returns:

True if the axis is a slicer axis, false otherwise.

Throws:

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

getTupleCount

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

Gets the number of tuples in this axis.

Returns:

The number of tuples in this axis.

Throws:

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

getClusterCount

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

Gets the number of clusters in this axis.

Returns:

The number of clusters in this axis.

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

Returns:

Number of dimensions in this axis.

Throws:

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

getAllDimensions

IEssMdMember[] getAllDimensions()
                         throws com.essbase.api.base.EssException

Returns an array of all dimensions in this axis. IEssMdMembers returned by this call do not have the property values for member properties. They just provide the meta-info (e.g. dimension name and number of properties and their data types) for the actual members of these dimensions present in this axis.

Returns:

An array of IEssMdMember interface.

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 axis's tuple members at a given 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.

getAllClusters

IEssMdCluster[] getAllClusters()
                        throws com.essbase.api.base.EssException

Returns an array of all the clusters in this axis.

Returns:

An array of IEssMdCluster interface.

Throws:

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