net.sf.jasperreports.olap

Class Olap4jMondrianQueryExecuter

java.lang.Object

net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

net.sf.jasperreports.olap.Olap4jMondrianQueryExecuter

All Implemented Interfaces:

JRQueryExecuter

public class Olap4jMondrianQueryExecuter
extends JRAbstractQueryExecuter

Author:

swood

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

JRAbstractQueryExecuter.QueryParameter, JRAbstractQueryExecuter.QueryParameterEntry, JRAbstractQueryExecuter.QueryParameterVisitor, JRAbstractQueryExecuter.ValuedQueryParameter, JRAbstractQueryExecuter.VisitExceptionWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEPTION_MESSAGE_KEY_CONNECTION_ERROR
static String	EXCEPTION_MESSAGE_KEY_EXECUTE_QUERY_ERROR
static String	OLAP4J_DRIVER
static String	OLAP4J_JDBC_CATALOG
static String	OLAP4J_JDBC_DRIVERS
static String	OLAP4J_JDBC_PASSWORD
static String	OLAP4J_JDBC_URL
static String	OLAP4J_JDBC_USER
static String	OLAP4J_MONDRIAN_DRIVER_CLASS
static String	OLAP4J_MONDRIAN_URL_PREFIX
static String	OLAP4J_URL_PREFIX

Fields inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

CLAUSE_POSITION_ID, clauseFunctions, dataset, EXCEPTION_MESSAGE_KEY_NUMERIC_TYPE_REQUIRED, EXCEPTION_MESSAGE_KEY_PARAMETER_NOT_FOUND, EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_CIRCULARLY_NESTED_PARAMETER, EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_ID_FIRST_TOKEN_MISSING, EXCEPTION_MESSAGE_KEY_QUERY_CLAUSE_NOT_FOUND, EXCEPTION_MESSAGE_KEY_UNSUPPORTED_PARAMETER_TYPE, GET_COLLECTED

Constructor Summary

Constructors

Constructor and Description
Olap4jMondrianQueryExecuter(JasperReportsContext jasperReportsContext, JRDataset dataset, Map<String,? extends JRValueParameter> parametersMap)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancelQuery() Cancels the query if it's currently running.
void	close() Closes resources kept open during the data source iteration.
JRDataSource	createDatasource() Executes the query and creates a JRDataSource out of the result.
protected String	getCanonicalQueryLanguage() Returns a canonical query language for this query executer implementation.
protected String	getParameterReplacement(String parameterName) Returns the replacement text for a query parameter.
JROlapResult	getResult()

Methods inherited from class net.sf.jasperreports.engine.query.JRAbstractQueryExecuter

addQueryMultiParameters, addQueryMultiParameters, addQueryParameter, addQueryParameter, appendClauseChunk, appendParameterChunk, appendParameterClauseChunk, appendQueryChunk, appendTextChunk, applyClause, checkParameter, findExtensionQueryFunction, getBooleanParameter, getBooleanParameter, getBooleanParameterOrProperty, getBooleanParameterOrProperty, getCollectedParameterNames, getCollectedParameters, getJasperReportsContext, getParameter, getParameterValue, getParameterValue, getPropertiesUtil, getQueryString, getStringParameter, getStringParameterOrProperty, getValueParameter, getValueParameter, parameterHasValue, parseQuery, registerClauseFunction, resolveFunction, unregisterClauseFunction, visitQueryParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXCEPTION_MESSAGE_KEY_CONNECTION_ERROR

public static final String EXCEPTION_MESSAGE_KEY_CONNECTION_ERROR

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_EXECUTE_QUERY_ERROR

public static final String EXCEPTION_MESSAGE_KEY_EXECUTE_QUERY_ERROR

See Also:

Constant Field Values

OLAP4J_DRIVER

public static final String OLAP4J_DRIVER

See Also:

Constant Field Values

OLAP4J_URL_PREFIX

public static final String OLAP4J_URL_PREFIX

See Also:

Constant Field Values

OLAP4J_JDBC_DRIVERS

public static final String OLAP4J_JDBC_DRIVERS

See Also:

Constant Field Values

OLAP4J_JDBC_URL

public static final String OLAP4J_JDBC_URL

See Also:

Constant Field Values

OLAP4J_JDBC_CATALOG

public static final String OLAP4J_JDBC_CATALOG

See Also:

Constant Field Values

OLAP4J_JDBC_USER

public static final String OLAP4J_JDBC_USER

See Also:

Constant Field Values

OLAP4J_JDBC_PASSWORD

public static final String OLAP4J_JDBC_PASSWORD

See Also:

Constant Field Values

OLAP4J_MONDRIAN_DRIVER_CLASS

public static final String OLAP4J_MONDRIAN_DRIVER_CLASS

See Also:

Constant Field Values

OLAP4J_MONDRIAN_URL_PREFIX

public static final String OLAP4J_MONDRIAN_URL_PREFIX

See Also:

Constant Field Values

Constructor Detail

Olap4jMondrianQueryExecuter

public Olap4jMondrianQueryExecuter(JasperReportsContext jasperReportsContext,
                           JRDataset dataset,
                           Map<String,? extends JRValueParameter> parametersMap)

Method Detail

getCanonicalQueryLanguage

protected String getCanonicalQueryLanguage()

Description copied from class: JRAbstractQueryExecuter

Returns a canonical query language for this query executer implementation.

The canonical language is used to retrieve extensions for the query executer.

The default implementation returns the runtime query language used in the dataset, but query executer implementations should override this method and return a fixed language.

Overrides:

getCanonicalQueryLanguage in class JRAbstractQueryExecuter

Returns:

a canonical query language

getParameterReplacement

protected String getParameterReplacement(String parameterName)

Description copied from class: JRAbstractQueryExecuter

Returns the replacement text for a query parameter.

Specified by:

getParameterReplacement in class JRAbstractQueryExecuter

Parameters:

parameterName - the parameter name

Returns:

the replacement text

See Also:

JRQueryChunk.TYPE_PARAMETER

createDatasource

public JRDataSource createDatasource()
                              throws JRException

Description copied from interface: JRQueryExecuter

Executes the query and creates a JRDataSource out of the result.

Returns:

a JRDataSource wrapping the query execution result.

Throws:

JRException

cancelQuery

public boolean cancelQuery()
                    throws JRException

Description copied from interface: JRQueryExecuter

Cancels the query if it's currently running.

This method will be called from a different thread if the client decides to cancel the filling process.

Returns:

true if and only if the query was running and it has been canceled

Throws:

JRException

getResult

public JROlapResult getResult()

close

public void close()

Description copied from interface: JRQueryExecuter

Closes resources kept open during the data source iteration.

This method is called after the report is filled or the dataset is iterated. If a resource is not needed after the data source has been created, it should be released at the end of createDatasource.