mondrian.olap4j
Class MondrianOlap4jExtra

java.lang.Object
  extended by mondrian.olap4j.MondrianOlap4jExtra
All Implemented Interfaces:
XmlaHandler.XmlaExtra

 class MondrianOlap4jExtra
extends Object
implements XmlaHandler.XmlaExtra

Provides access to internals of mondrian's olap4j driver that are not part of the olap4j API.

Since:
Nov 12, 2010
Author:
jhyde

Nested Class Summary
 
Nested classes/interfaces inherited from interface mondrian.xmla.XmlaHandler.XmlaExtra
XmlaHandler.XmlaExtra.FunctionDefinition
 
Field Summary
(package private) static MondrianOlap4jExtra INSTANCE
           
 
Constructor Summary
MondrianOlap4jExtra()
           
 
Method Summary
 void checkMemberOrdinal(Member member)
           
 ResultSet executeDrillthrough(OlapStatement olapStatement, String mdx, boolean advanced, String tabFields, int[] rowCountSlot)
           
 Map<String,Object> getAnnotationMap(MetadataElement element)
          Returns a map containing annotations on this element.
 String getCubeType(Cube cube)
           
 List<Map<String,Object>> getDataSources(OlapConnection connection)
          Returns a list of the data sources in this server.
 int getHierarchyCardinality(Hierarchy hierarchy)
           
 int getHierarchyStructure(Hierarchy hierarchy)
           
 int getLevelCardinality(Level level)
           
 List<Property> getLevelProperties(Level level)
          Returns the defined properties of a level.
 int getMeasureAggregator(Member member)
           
 void getSchemaFunctionList(List<XmlaHandler.XmlaExtra.FunctionDefinition> funDefs, Schema schema, Util.Functor1<Boolean,String> functionFilter)
           
 Date getSchemaLoadDate(Schema schema)
           
 List<String> getSchemaRoleNames(Schema schema)
          Returns a list of names of roles in the given schema to which the current user belongs.
 boolean isHierarchyParentChild(Hierarchy hierarchy)
           
 boolean isLevelUnique(Level level)
           
 boolean isPropertyInternal(Property property)
           
 void setPreferList(OlapConnection connection)
           
 boolean shouldReturnCellProperty(CellSet cellSet, Property cellProperty, boolean evenEmpty)
          Returns whether we should return a cell property in the XMLA result.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INSTANCE

static final MondrianOlap4jExtra INSTANCE
Constructor Detail

MondrianOlap4jExtra

MondrianOlap4jExtra()
Method Detail

executeDrillthrough

public ResultSet executeDrillthrough(OlapStatement olapStatement,
                                     String mdx,
                                     boolean advanced,
                                     String tabFields,
                                     int[] rowCountSlot)
                              throws SQLException
Specified by:
executeDrillthrough in interface XmlaHandler.XmlaExtra
Throws:
SQLException

setPreferList

public void setPreferList(OlapConnection connection)
Specified by:
setPreferList in interface XmlaHandler.XmlaExtra

getSchemaLoadDate

public Date getSchemaLoadDate(Schema schema)
Specified by:
getSchemaLoadDate in interface XmlaHandler.XmlaExtra

getLevelCardinality

public int getLevelCardinality(Level level)
                        throws OlapException
Specified by:
getLevelCardinality in interface XmlaHandler.XmlaExtra
Throws:
OlapException

getSchemaFunctionList

public void getSchemaFunctionList(List<XmlaHandler.XmlaExtra.FunctionDefinition> funDefs,
                                  Schema schema,
                                  Util.Functor1<Boolean,String> functionFilter)
Specified by:
getSchemaFunctionList in interface XmlaHandler.XmlaExtra

getHierarchyCardinality

public int getHierarchyCardinality(Hierarchy hierarchy)
                            throws OlapException
Specified by:
getHierarchyCardinality in interface XmlaHandler.XmlaExtra
Throws:
OlapException

getHierarchyStructure

public int getHierarchyStructure(Hierarchy hierarchy)
Specified by:
getHierarchyStructure in interface XmlaHandler.XmlaExtra

isHierarchyParentChild

public boolean isHierarchyParentChild(Hierarchy hierarchy)
Specified by:
isHierarchyParentChild in interface XmlaHandler.XmlaExtra

getMeasureAggregator

public int getMeasureAggregator(Member member)
Specified by:
getMeasureAggregator in interface XmlaHandler.XmlaExtra

checkMemberOrdinal

public void checkMemberOrdinal(Member member)
                        throws OlapException
Specified by:
checkMemberOrdinal in interface XmlaHandler.XmlaExtra
Throws:
OlapException

shouldReturnCellProperty

public boolean shouldReturnCellProperty(CellSet cellSet,
                                        Property cellProperty,
                                        boolean evenEmpty)
Description copied from interface: XmlaHandler.XmlaExtra
Returns whether we should return a cell property in the XMLA result.

Specified by:
shouldReturnCellProperty in interface XmlaHandler.XmlaExtra
Parameters:
cellSet - Cell set
cellProperty - Cell property definition
evenEmpty - Whether to return even if cell has no properties
Returns:
Whether to return cell property in XMLA result

getSchemaRoleNames

public List<String> getSchemaRoleNames(Schema schema)
Description copied from interface: XmlaHandler.XmlaExtra
Returns a list of names of roles in the given schema to which the current user belongs.

Specified by:
getSchemaRoleNames in interface XmlaHandler.XmlaExtra
Parameters:
schema - Schema
Returns:
List of roles

getCubeType

public String getCubeType(Cube cube)
Specified by:
getCubeType in interface XmlaHandler.XmlaExtra

isLevelUnique

public boolean isLevelUnique(Level level)
Specified by:
isLevelUnique in interface XmlaHandler.XmlaExtra

getLevelProperties

public List<Property> getLevelProperties(Level level)
Description copied from interface: XmlaHandler.XmlaExtra
Returns the defined properties of a level. (Not including system properties that every level has.)

Specified by:
getLevelProperties in interface XmlaHandler.XmlaExtra
Parameters:
level - Level
Returns:
Defined properties

isPropertyInternal

public boolean isPropertyInternal(Property property)
Specified by:
isPropertyInternal in interface XmlaHandler.XmlaExtra

getDataSources

public List<Map<String,Object>> getDataSources(OlapConnection connection)
                                        throws OlapException
Description copied from interface: XmlaHandler.XmlaExtra
Returns a list of the data sources in this server. One element per data source, each element a map whose keys are the XMLA fields describing a data source: "DataSourceName", "DataSourceDescription", "URL", etc. Unrecognized fields are ignored.

Specified by:
getDataSources in interface XmlaHandler.XmlaExtra
Parameters:
connection - Connection
Returns:
List of data source definitions
Throws:
OlapException - on error

getAnnotationMap

public Map<String,Object> getAnnotationMap(MetadataElement element)
                                    throws SQLException
Description copied from interface: XmlaHandler.XmlaExtra
Returns a map containing annotations on this element.

Specified by:
getAnnotationMap in interface XmlaHandler.XmlaExtra
Parameters:
element - Element
Returns:
Annotation map, never null
Throws:
SQLException

Get Mondrian at SourceForge.net. Fast, secure and free Open Source software downloads