org.olap4j

Interface CellSetAxisMetaData

public interface CellSetAxisMetaData

Description of structure of a particular axis of an CellSet.

For example, in the MDX statement

 SELECT
   {[Measures].Members} ON COLUMNS,
   CrossJoin([Store].Members, [Gender].Children)
   DIMENSION PROPERTIES
      MEMBER_ORDINAL,
      MEMBER_UNIQUE_NAME,
      DISPLAY_INFO ON ROWS
 FROM [Sales]
 

the ROWS axis is described by the following metadata:

Attribute	Value
hierarchies	{[Store], [Gender]}
properties	{MEMBER_ORDINAL, MEMBER_UNIQUE_NAME, DISPLAY_INFO}

Since:

Oct 23, 2006

Author:

jhyde

Method Summary

Modifier and Type	Method and Description
Axis	getAxisOrdinal() Returns the definition of the axis.
List<Hierarchy>	getHierarchies() Returns the hierarchies which are mapped onto this axis.
List<Property>	getProperties() Returns the member properties which are returned on this axis.

Method Detail

getAxisOrdinal

Axis getAxisOrdinal()

Returns the definition of the axis. Typical values are (Axis.FILTER, Axis.COLUMNS, Axis.ROWS, and so forth.)

Returns:

the Axis

getHierarchies

List<Hierarchy> getHierarchies()

Returns the hierarchies which are mapped onto this axis.

Returns:

list of hierarchies on this Axis

getProperties

List<Property> getProperties()

Returns the member properties which are returned on this axis.

This method does not return a NamedList because the names of the properties are not necessarily unique; for example, there might be two hierarchies on the axis, each of which returns the DISPLAY_INFO property.

Returns:

list of member properties on this Axis