Package org.pentaho.reporting.engine.classic.core

Interface MultiStreamReportProcessTask

All Superinterfaces:

ReportProcessTask, Runnable

All Known Implementing Classes:

AbstractMultiStreamReportProcessTask, FlowCSVReportProcessTask, FlowHtmlReportProcessTask, PageableHtmlReportProcessTask, StreamHtmlReportProcessTask

public interface MultiStreamReportProcessTask
extends ReportProcessTask

A export task that generates multiple streams, like the HTML-output does. The report document itself will go into the bodyLocation, while any additional files generated during the export go into the bulk location. Be aware that if the export generates multiple report-documents (ie. multiple HTML files) then they all go into the body-location, while any image or stylesheet goes into the bulk location.

If no bulk location is given, then no extra files shall be generated.

Author:

Thomas Morgner

Method Summary

Modifier and Type	Method	Description
org.pentaho.reporting.libraries.repository.ContentLocation	getBulkLocation()	Returns the defined bulk location for the export.
org.pentaho.reporting.libraries.repository.NameGenerator	getBulkNameGenerator()	Returns the name generator for bulk content.
URLRewriter	getUrlRewriter()	Returns the URL rewriter used during the export.
void	setBulkLocation(org.pentaho.reporting.libraries.repository.ContentLocation bulkLocation)	Defines the bulk location, where additional content can be stored.
void	setBulkNameGenerator(org.pentaho.reporting.libraries.repository.NameGenerator bulkNameGenerator)	Defines the bulk file name generator that is used to generate unique names for the exported files.
void	setUrlRewriter(URLRewriter urlRewriter)	Defines the URL rewriter that is used to link bulk items to the main document.

Methods inherited from interface org.pentaho.reporting.engine.classic.core.ReportProcessTask

addReportProgressListener, getBodyContentLocation, getBodyNameGenerator, getError, getReport, getReportMimeType, isTaskAborted, isTaskSuccessful, isValid, removeReportProgressListener, setBodyContentLocation, setBodyNameGenerator, setReport

Methods inherited from interface java.lang.Runnable

run

Method Detail

setBulkLocation

void setBulkLocation(org.pentaho.reporting.libraries.repository.ContentLocation bulkLocation)

Defines the bulk location, where additional content can be stored.

Parameters:

bulkLocation - the bulk location.

getBulkLocation

org.pentaho.reporting.libraries.repository.ContentLocation getBulkLocation()

Returns the defined bulk location for the export.

Returns:

the bulk location.

setBulkNameGenerator

void setBulkNameGenerator(org.pentaho.reporting.libraries.repository.NameGenerator bulkNameGenerator)

Defines the bulk file name generator that is used to generate unique names for the exported files. If a bulk location is given, this property must not be null.

Parameters:

bulkNameGenerator - the name generator.

getBulkNameGenerator

org.pentaho.reporting.libraries.repository.NameGenerator getBulkNameGenerator()

Returns the name generator for bulk content.

Returns:

the bulk file name generator.

setUrlRewriter

void setUrlRewriter(URLRewriter urlRewriter)

Defines the URL rewriter that is used to link bulk items to the main document.

Parameters:

urlRewriter - the URL rewriter used in the export.

getUrlRewriter

URLRewriter getUrlRewriter()

Returns the URL rewriter used during the export.

Returns:

the URL rewriter that is used to generate or alter URLs pointing to bulk items.