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

Class Query2Resource

java.lang.Object

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

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

public class Query2Resource
extends Object

Saiku Query Endpoints

Constructor Summary

Constructors

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

Method Summary

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

Query2Resource

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

Method Details

deleteQuery

public Status deleteQuery(String queryName)

Delete query from the query pool.

createQuery

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

Create a new Saiku Query.

Throws:

ServletException

execute

public QueryResult execute(String username,
 ThinQuery tq)

Execute a Saiku Query

cancel

public Response cancel(String username,
 String queryName)

Cancel a running query.

enrich

public ThinQuery enrich(String username,
 ThinQuery tq)

Enrich a thin query model

getLevelMembers

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

Get level members from a query.

getQueryExcelExport

public Response getQueryExcelExport(String username,
 String queryName)

Query export to excel.

getQueryExcelExport

public Response getQueryExcelExport(String username,
 String queryName,
 String format,
 String name)

Query export to excel

getQueryCsvExport

public Response getQueryCsvExport(String username,
 String queryName)

Get CSV export of a query.

getQueryCsvExport

public Response getQueryCsvExport(String username,
 String queryName,
 String format,
 String name)

Get CSV export of a query.

zoomIn

public ThinQuery zoomIn(String username,
 String queryName,
 String positionListString)

Zoom into a query result table.

drillthrough

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

Drill through on the query result set.

getDrillthroughExport

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

Export the drill through to a CSV file for further analysis

exportPdfWithChart

public Response exportPdfWithChart(String username,
 String queryName,
 String svg)

Export PDF with chart

exportPdf

public Response exportPdf(String username,
 String queryName)

Export table to PDF.

exportPdfWithFormat

public Response exportPdfWithFormat(String username,
 String queryName,
 String format,
 String name)

Export to PDF with cellset format.

exportPdfWithChartAndFormat

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

Export PDF with chart and cellset format.

exportHtml

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

Get HTML export

exportHtml

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

Get HTML export

drillacross

public ThinQuery drillacross(String username,
 String queryName,
 String position,
 String returns)

Drill across on a result set