Package com.gooddata.sdk.service.export

Class ExportService

java.lang.Object

com.gooddata.sdk.service.AbstractService

com.gooddata.sdk.service.export.ExportService

public class ExportService
extends AbstractService

Export project data

Nested Class Summary

Nested classes/interfaces inherited from class com.gooddata.sdk.service.AbstractService

AbstractService.OutputStreamResponseExtractor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPORTING_URI
static final org.springframework.web.util.UriTemplate	OBJ_TEMPLATE
static final org.springframework.web.util.UriTemplate	PROJECT_TEMPLATE

Fields inherited from class com.gooddata.sdk.service.AbstractService

mapper, restTemplate

Constructor Summary

Constructors

Constructor	Description
ExportService(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings)	Service for data export

Method Summary

Modifier and Type	Method	Description
protected com.fasterxml.jackson.databind.JsonNode	executeReport(String executionUri, ReportRequest request)
FutureResult<Void>	export(ReportDefinition reportDefinition, ExportFormat format, OutputStream output)	Export the given report definition in the given format to the given output stream
FutureResult<Void>	export(Report report, ExportFormat format, OutputStream output)	Export the given report in the given format to the given output stream
FutureResult<Void>	exportCsv(ReportDefinition definition, OutputStream output)	Export the given Report Definition using the raw export (without columns/rows limitations)
FutureResult<Void>	exportCsv(Report report, OutputStream output)	Export the given Report using the raw export (without columns/rows limitations)
FutureResult<Void>	exportPdf(GoodDataEndpoint endpoint, ProjectDashboard dashboard, ProjectDashboard.Tab tab, OutputStream output)	Export the given dashboard tab in PDF format to the given output stream

Methods inherited from class com.gooddata.sdk.service.AbstractService

extractData

Methods inherited from class java.lang.Object

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

Field Details

EXPORTING_URI

public static final String EXPORTING_URI

See Also:

• Constant Field Values

OBJ_TEMPLATE

public static final org.springframework.web.util.UriTemplate OBJ_TEMPLATE

PROJECT_TEMPLATE

public static final org.springframework.web.util.UriTemplate PROJECT_TEMPLATE

Constructor Details

ExportService

public ExportService(org.springframework.web.client.RestTemplate restTemplate,
 GoodDataSettings settings)

Service for data export

Parameters:

restTemplate - REST template

settings - settings

Method Details

export

public FutureResult<Void> export(ReportDefinition reportDefinition,
 ExportFormat format,
 OutputStream output)

Export the given report definition in the given format to the given output stream

Parameters:

reportDefinition - report definition

format - export format

output - target

Returns:

polling result

Throws:

NoDataExportException - in case report contains no data

ExportException - on error

export

public FutureResult<Void> export(Report report,
 ExportFormat format,
 OutputStream output)

Export the given report in the given format to the given output stream

Parameters:

report - report

format - export format

output - target

Returns:

polling result

Throws:

NoDataExportException - in case report contains no data

ExportException - on error

executeReport

protected com.fasterxml.jackson.databind.JsonNode executeReport(String executionUri,
 ReportRequest request)

exportPdf

public FutureResult<Void> exportPdf(GoodDataEndpoint endpoint,
 ProjectDashboard dashboard,
 ProjectDashboard.Tab tab,
 OutputStream output)

Export the given dashboard tab in PDF format to the given output stream

Parameters:

endpoint - endpoint for which the export is generated

dashboard - dashboard

tab - tab

output - output

Returns:

polling result

Throws:

ExportException - if export fails

exportCsv

public FutureResult<Void> exportCsv(Report report,
 OutputStream output)

Export the given Report using the raw export (without columns/rows limitations)

Parameters:

report - report

output - output

Returns:

polling result

Throws:

ExportException - in case export fails

exportCsv

public FutureResult<Void> exportCsv(ReportDefinition definition,
 OutputStream output)

Export the given Report Definition using the raw export (without columns/rows limitations)

Parameters:

definition - report definition

output - output

Returns:

polling result

Throws:

ExportException - in case export fails