org.olap4j

Interface CellSetMetaData

All Superinterfaces:

OlapWrapper, ResultSetMetaData, Wrapper

public interface CellSetMetaData
extends ResultSetMetaData, OlapWrapper

An object that can be used to get information about the axes and cells in a CellSet object.

The following code fragment creates the CellSet object cs, creates the CellSetMetaData object csmd, and uses csmd to find out how many axes cs has and the name of the cube.

 CellSet cs = stmt.executeOlapQuery(
     "SELECT {[Measures].[Unit Sales] ON COLUMNS,\n" +
     "   Crossjoin([Time].Children, [Store].Children) ON ROWS\n" +
     "FROM [Sales]");
 CellSetMetaData csmd = cs.getMetaData();
 int numberOfAxes = csmd.getAxesMetaData().size();
 String cubeName = csmd.getCube().getName();
 

Since:

Oct 23, 2006

Author:

jhyde

Field Summary

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

Method Summary

Modifier and Type	Method and Description
NamedList<CellSetAxisMetaData>	getAxesMetaData() Returns a list of CellSetAxisMetaData describing each result axis.
NamedList<Property>	getCellProperties() Returns a list of Property objects which each Cell may have.
Cube	getCube() Returns the Cube which was referenced in this statement.
CellSetAxisMetaData	getFilterAxisMetaData() Returns a CellSetAxisMetaData describing the filter axis.

Methods inherited from interface java.sql.ResultSetMetaData

getCatalogName, getColumnClassName, getColumnCount, getColumnDisplaySize, getColumnLabel, getColumnName, getColumnType, getColumnTypeName, getPrecision, getScale, getSchemaName, getTableName, isAutoIncrement, isCaseSensitive, isCurrency, isDefinitelyWritable, isNullable, isReadOnly, isSearchable, isSigned, isWritable

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Methods inherited from interface org.olap4j.OlapWrapper

isWrapperFor, unwrap

Method Detail

getCellProperties

NamedList<Property> getCellProperties()

Returns a list of Property objects which each Cell may have.

Returns:

list of cell properties

getCube

Cube getCube()

Returns the Cube which was referenced in this statement.

Returns:

cube referenced in this statement

getAxesMetaData

NamedList<CellSetAxisMetaData> getAxesMetaData()

Returns a list of CellSetAxisMetaData describing each result axis.

Returns:

list of metadata describing each result axis

getFilterAxisMetaData

CellSetAxisMetaData getFilterAxisMetaData()

Returns a CellSetAxisMetaData describing the filter axis. Never returns null; if the MDX statement contains no WHERE clause, the description of the filter contains no hierarchies.

Returns:

metadata describing filter axis