net.datenwerke.rs.saiku.server.rest.resources

Class Query2Resource

java.lang.Object

net.datenwerke.rs.saiku.server.rest.resources.Query2Resource

public class Query2Resource
extends java.lang.Object

Saiku Query Endpoints

Constructor Summary

Constructors

Constructor and Description
Query2Resource(OlapUtilService olapUtils, ThinQueryService thinQueryService, <any> saikuSessionContainer, <any> authenticatorService, SecurityService securityService)

Method Summary

Modifier and Type	Method and Description
Response	cancel(java.lang.String username, java.lang.String queryName) Cancel a running query.
ThinQuery	createQuery(java.lang.String username, java.lang.String queryName, java.lang.String jsonFormParam, java.lang.String fileFormParam, <any> formParams) Create a new Saiku Query.
Status	deleteQuery(java.lang.String queryName) Delete query from the query pool.
ThinQuery	drillacross(java.lang.String username, java.lang.String queryName, java.lang.String position, java.lang.String returns) Drill across on a result set
QueryResult	drillthrough(java.lang.String username, java.lang.String queryName, java.lang.Integer maxrows, java.lang.String position, java.lang.String returns) Drill through on the query result set.
ThinQuery	enrich(java.lang.String username, ThinQuery tq) Enrich a thin query model
QueryResult	execute(java.lang.String username, ThinQuery tq) Execute a Saiku Query
Response	exportHtml(java.lang.String username, java.lang.String queryname, java.lang.String format, java.lang.Boolean css, java.lang.Boolean tableonly, java.lang.Boolean wrapcontent) Get HTML export
Response	exportHtml(java.lang.String username, ThinQuery tq, java.lang.String format, java.lang.Boolean css, java.lang.Boolean tableonly, java.lang.Boolean wrapcontent) Get HTML export
Response	exportPdf(java.lang.String username, java.lang.String queryName) Export table to PDF.
Response	exportPdfWithChart(java.lang.String username, java.lang.String queryName, java.lang.String svg) Export PDF with chart
Response	exportPdfWithChartAndFormat(java.lang.String username, java.lang.String queryName, java.lang.String format, java.lang.String svg, java.lang.String name) Export PDF with chart and cellset format.
Response	exportPdfWithFormat(java.lang.String username, java.lang.String queryName, java.lang.String format, java.lang.String name) Export to PDF with cellset format.
Response	getDrillthroughExport(java.lang.String username, java.lang.String queryName, java.lang.Integer maxrows, java.lang.String position, java.lang.String returns) Export the drill through to a CSV file for further analysis
java.util.List<SimpleCubeElement>	getLevelMembers(java.lang.String username, java.lang.String queryName, java.lang.String hierarchyName, java.lang.String levelName, boolean result, java.lang.String searchString, int searchLimit) Get level members from a query.
Response	getQueryCsvExport(java.lang.String username, java.lang.String queryName) Get CSV export of a query.
Response	getQueryCsvExport(java.lang.String username, java.lang.String queryName, java.lang.String format, java.lang.String name) Get CSV export of a query.
Response	getQueryExcelExport(java.lang.String username, java.lang.String queryName) Query export to excel.
Response	getQueryExcelExport(java.lang.String username, java.lang.String queryName, java.lang.String format, java.lang.String name) Query export to excel
ThinQuery	zoomIn(java.lang.String username, java.lang.String queryName, java.lang.String positionListString) Zoom into a query result table.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query2Resource

public Query2Resource(OlapUtilService olapUtils,
                      ThinQueryService thinQueryService,
                      <any> saikuSessionContainer,
                      <any> authenticatorService,
                      SecurityService securityService)

Method Detail

deleteQuery

public Status deleteQuery(java.lang.String queryName)

Delete query from the query pool.

Parameters:

queryName - The query name

Returns:

a HTTP 410(Works) or HTTP 500(Call failed).

createQuery

public ThinQuery createQuery(java.lang.String username,
                             java.lang.String queryName,
                             java.lang.String jsonFormParam,
                             java.lang.String fileFormParam,
                             <any> formParams)
                      throws ServletException

Create a new Saiku Query.

Parameters:

queryName - The query name

fileFormParam - The file

jsonFormParam - The json

formParams - The form params

Returns:

a query model.

Throws:

ServletException

execute

public QueryResult execute(java.lang.String username,
                           ThinQuery tq)

Execute a Saiku Query

Parameters:

tq - Thin Query model

Returns:

A query result set.

cancel

public Response cancel(java.lang.String username,
                       java.lang.String queryName)

Cancel a running query.

Parameters:

queryName - The query name

Returns:

A 410 on success

enrich

public ThinQuery enrich(java.lang.String username,
                        ThinQuery tq)

Enrich a thin query model

Parameters:

tq - The thin query

Returns:

An updated thin query.

getLevelMembers

public java.util.List<SimpleCubeElement> getLevelMembers(java.lang.String username,
                                                         java.lang.String queryName,
                                                         java.lang.String hierarchyName,
                                                         java.lang.String levelName,
                                                         boolean result,
                                                         java.lang.String searchString,
                                                         int searchLimit)

Get level members from a query.

Parameters:

queryName - The query name

hierarchyName - The hierarchy name

levelName - The level name

result - Use the current result

searchString - The search string

searchLimit - The search limit

Returns:

getQueryExcelExport

public Response getQueryExcelExport(java.lang.String username,
                                    java.lang.String queryName)

Query export to excel.

Parameters:

queryName - The query name

Returns:

A response containing an excel spreadsheet.

getQueryExcelExport

public Response getQueryExcelExport(java.lang.String username,
                                    java.lang.String queryName,
                                    java.lang.String format,
                                    java.lang.String name)

Query export to excel

Parameters:

queryName - The query

format - The cellset format

name - The export name

Returns:

A response containing and excel spreadsheet.

getQueryCsvExport

public Response getQueryCsvExport(java.lang.String username,
                                  java.lang.String queryName)

Get CSV export of a query.

Parameters:

queryName - The query name

Returns:

A response containing a CSV file

getQueryCsvExport

public Response getQueryCsvExport(java.lang.String username,
                                  java.lang.String queryName,
                                  java.lang.String format,
                                  java.lang.String name)

Get CSV export of a query.

Parameters:

queryName - The query name

format - The cell set format

name - The export name

Returns:

A response containing a CSV file

zoomIn

public ThinQuery zoomIn(java.lang.String username,
                        java.lang.String queryName,
                        java.lang.String positionListString)

Zoom into a query result table.

Parameters:

queryName - The query name

positionListString - The zoom position

Returns:

A new thin query model with a reduced table.

drillthrough

public QueryResult drillthrough(java.lang.String username,
                                java.lang.String queryName,
                                java.lang.Integer maxrows,
                                java.lang.String position,
                                java.lang.String returns)

Drill through on the query result set.

Parameters:

queryName - The query name

maxrows - The max rows returned

position - The position

returns - The returned dimensions and levels

Returns:

A query result set.

getDrillthroughExport

public Response getDrillthroughExport(java.lang.String username,
                                      java.lang.String queryName,
                                      java.lang.Integer maxrows,
                                      java.lang.String position,
                                      java.lang.String returns)

Export the drill through to a CSV file for further analysis

Parameters:

queryName - The query name

maxrows - The max rows

position - The position

returns - The returned dimensions and levels

Returns:

A response containing a CSV file

exportPdfWithChart

public Response exportPdfWithChart(java.lang.String username,
                                   java.lang.String queryName,
                                   java.lang.String svg)

Export PDF with chart

Parameters:

queryName - The query.

svg - The SVG string

Returns:

A response with a PDF file

exportPdf

public Response exportPdf(java.lang.String username,
                          java.lang.String queryName)

Export table to PDF.

Parameters:

queryName - The query name

Returns:

A response with a PDF export.

exportPdfWithFormat

public Response exportPdfWithFormat(java.lang.String username,
                                    java.lang.String queryName,
                                    java.lang.String format,
                                    java.lang.String name)

Export to PDF with cellset format.

Parameters:

queryName - The query

format - The cellset format

name - The name of the export.

Returns:

A response with a PDF

exportPdfWithChartAndFormat

public Response exportPdfWithChartAndFormat(java.lang.String username,
                                            java.lang.String queryName,
                                            java.lang.String format,
                                            java.lang.String svg,
                                            java.lang.String name)

Export PDF with chart and cellset format.

Parameters:

queryName - The query name

format - The cell set format

svg - The SVG

name - The export name

Returns:

A response with a PDF contained.

exportHtml

public Response exportHtml(java.lang.String username,
                           java.lang.String queryname,
                           java.lang.String format,
                           java.lang.Boolean css,
                           java.lang.Boolean tableonly,
                           java.lang.Boolean wrapcontent)

Get HTML export

Parameters:

queryname - The query name

format - The cellset format

css - The css stylesheet

tableonly - Export table only or chart as well

wrapcontent - Wrap content

Returns:

A response with a HTML export.

exportHtml

public Response exportHtml(java.lang.String username,
                           ThinQuery tq,
                           java.lang.String format,
                           java.lang.Boolean css,
                           java.lang.Boolean tableonly,
                           java.lang.Boolean wrapcontent)

Get HTML export

Parameters:

tq - The current thin query model

format - The cellset format

css - The css stylesheet

tableonly - Export table only or chart as well

wrapcontent - Wrap content

Returns:

A response with a HTML export.

drillacross

public ThinQuery drillacross(java.lang.String username,
                             java.lang.String queryName,
                             java.lang.String position,
                             java.lang.String returns)

Drill across on a result set

Parameters:

queryName - The query name

position - The drill position

returns - The dimensions and levels returned

Returns:

The new thin query object.