Package com.activeviam.activepivot.core.intf.api.query.drillthrough

Interface IDrillthroughExecutor

All Superinterfaces:

IExtendedPluginValue

All Known Implementing Classes:

DistributedDrillthroughExecutor, DrillthroughExecutor

public interface IDrillthroughExecutor
extends IExtendedPluginValue

The drillthrough executor, created for each new IActivePivotVersion.

Author:

ActiveViam

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PLUGIN_KEY	The default plugin key to use for this IExtendedPluginValue.

Method Summary

Modifier and Type	Method	Description
static IDrillthroughExecutor	create(String pluginKey, IDrillthroughSession session)	Creates an instance of this extended plugin.
List<Object[]>	execute(IDrillthroughQuery drillthroughQuery)	Executes the request to retrieve the properties of the drillthrough query.
List<Object[]>	execute(List<IDrillthroughHeader> headers, IDrillthroughQuery drillthroughQuery)	Executes the request to retrieve the properties of the drillthrough query.
List<IDrillthroughHeader>	executeHeaders(Collection<ILocation> locations, Collection<String> measures, boolean isDrillthroughContinuousQuery)	Retrieve the headers available for performing a drillthrough.

Methods inherited from interface com.activeviam.tech.core.api.registry.IExtendedPluginValue

getType

Field Details

DEFAULT_PLUGIN_KEY

static final String DEFAULT_PLUGIN_KEY

The default plugin key to use for this IExtendedPluginValue.

See Also:

• Constant Field Values

Method Details

execute

List<Object[]> execute(IDrillthroughQuery drillthroughQuery)

Executes the request to retrieve the properties of the drillthrough query.

Parameters:

drillthroughQuery - the query

Returns:

the computed rows

execute

List<Object[]> execute(List<IDrillthroughHeader> headers,
 IDrillthroughQuery drillthroughQuery)

Executes the request to retrieve the properties of the drillthrough query.

Parameters:

headers - the headers to execute this request. The headers are expected to have the IDrillthroughColumn correctly set (with the correct dependencies). Don't build the input list of headers yourself, it is advised to use executeHeaders(Collection, Collection, boolean) or executeHeaders(Collection, Collection, boolean) or to use directly execute(IDrillthroughQuery). The headers asked need to be visible.

drillthroughQuery - the query

Returns:

the computed rows

executeHeaders

List<IDrillthroughHeader> executeHeaders(Collection<ILocation> locations,
 Collection<String> measures,
 boolean isDrillthroughContinuousQuery)

Retrieve the headers available for performing a drillthrough.

Parameters:

locations - collection of locations on which the drillthrough header query is perfomed. Can be null.

measures - collection of measure names on which a drillthrough query is performed. Can be null. It can contains several elements when a drillthrough is performed on a calculated members. For instance, with the following formulas:

[Measures].[formula] AS [Measures].[delta.SUM] + [Measures].[gamma.SUM] the collection contains ["delta.SUM","gamma.SUM"]

isDrillthroughContinuousQuery - set to true if headers are needed for a IDrillthroughContinuousQuery.

Returns:

the list of headers.

create

static IDrillthroughExecutor create(String pluginKey,
 IDrillthroughSession session)

Creates an instance of this extended plugin.

Parameters:

pluginKey - key of the plugin to create

Returns:

the created executor