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

Class AbstractMultiStreamReportProcessTask

java.lang.Object

org.pentaho.reporting.engine.classic.core.AbstractReportProcessTask

org.pentaho.reporting.engine.classic.core.AbstractMultiStreamReportProcessTask

All Implemented Interfaces:

Runnable, MultiStreamReportProcessTask, ReportProcessTask

Direct Known Subclasses:

FlowCSVReportProcessTask, FlowHtmlReportProcessTask, PageableHtmlReportProcessTask, StreamHtmlReportProcessTask

public abstract class AbstractMultiStreamReportProcessTask
extends AbstractReportProcessTask
implements MultiStreamReportProcessTask

TA common base class for MultiStreamReportProcessTask implementations.

Author:

Thomas Morgner

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMultiStreamReportProcessTask()	Default Constructor.

Method Summary

Modifier and Type	Method	Description
protected URLRewriter	computeUrlRewriter()	A helper method that tries to come up with a reasonalbe URLrewriter for common repository configurations.
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 class org.pentaho.reporting.engine.classic.core.AbstractReportProcessTask

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

AbstractMultiStreamReportProcessTask

protected AbstractMultiStreamReportProcessTask()

Default Constructor.

Method Detail

getBulkLocation

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

Returns the defined bulk location for the export.

Specified by:

getBulkLocation in interface MultiStreamReportProcessTask

Returns:

the bulk location.

setBulkLocation

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

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

Specified by:

setBulkLocation in interface MultiStreamReportProcessTask

Parameters:

bulkLocation - the bulk location.

getBulkNameGenerator

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

Returns the name generator for bulk content.

Specified by:

getBulkNameGenerator in interface MultiStreamReportProcessTask

Returns:

the bulk file name generator.

setBulkNameGenerator

public 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.

Specified by:

setBulkNameGenerator in interface MultiStreamReportProcessTask

Parameters:

bulkNameGenerator - the name generator.

getUrlRewriter

public URLRewriter getUrlRewriter()

Returns the URL rewriter used during the export.

Specified by:

getUrlRewriter in interface MultiStreamReportProcessTask

Returns:

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

setUrlRewriter

public void setUrlRewriter(URLRewriter urlRewriter)

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

Specified by:

setUrlRewriter in interface MultiStreamReportProcessTask

Parameters:

urlRewriter - the URL rewriter used in the export.

computeUrlRewriter

protected URLRewriter computeUrlRewriter()

A helper method that tries to come up with a reasonalbe URLrewriter for common repository configurations. If there is a URLRewriter defined already, that one will be used. If both the bulk and body location point to the same repository backend, the SingleRepositoryURLRewriter is used. If both repositories are different but both are UrlRepositories, a FilesystemURLRewriter is used. If everything else fails, the method will fall back to a SingleRepositoryURLRewriter - hoping that it will work out.

Returns:

the computed URL rewriter.