Klasse EngineBundle

java.lang.Object

com.inet.report.EngineBundle

Alle implementierten Schnittstellen:

ReportGenerator

public class EngineBundle
extends Object
implements ReportGenerator

A bundle of multiple engines you want to render as one document. In the report URL the "reports" parameter can be used to set multiple reports you want to render as one, separated by semi-colon.

Seit:

15.0

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
EngineBundle(String format)	Create a new bundle of reports for the specified output format.

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
Engine	addReportFile(String reportUrl)	Add a new report template to this bundle and creates an engine.
void	execute()	See Engine.execute() for details.
Engine	getEngine0()	Get the first Engine from the bundle list.
List<Engine>	getEngines()	Get all Engines of this bundle.
int	getPageCount()	See Engine.getPageCount() for details.
byte[]	getPageData(int page)	See Engine.getPageData(int) for details.
PromptField	getPromptField(String name)	See Engine.getPromptField(String) for details.
@Nonnull EngineStatistics	getStatistics()	See Engine.getStatistics() for details.
void	setClientLocale(@Nonnull Locale locale)	See Engine.setClientLocale(Locale) for details.
void	setDocumentOutput(DocumentOutput documentOutput)	Set the output location for the rendered data.
void	setPrompt(String prompt, int i)	NOTE: Unlike Engine.setPrompt(String, int), the number i does not refer to prompt i in any engine, but will count from the first engine onwards.
void	setPrompt(String name, String prompt)	See Engine.setPrompt(String, String) for details.
void	setUserProperties(Properties props)	See Engine.setUserProperties(Properties) for details.
void	stop(String message)	See Engine.stop(String) for details.
void	stopAfterPage(int maxPageNo)	See Engine.stopAfterPage(int) for details.

Von Klasse geerbte Methoden Object

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

Konstruktordetails

EngineBundle

public EngineBundle(String format)
             throws ReportException

Create a new bundle of reports for the specified output format.

Parameter:

format - One of the constant form Engine.

Löst aus:

ReportException - if the format is not supported because it is tabular

Seit:

15.0

Methodendetails

addReportFile

public Engine addReportFile(String reportUrl)
                     throws ReportException

Add a new report template to this bundle and creates an engine.

Parameter:

reportUrl - the report URL or file path to the *.rpt template.

Gibt zurück:

the created engine

Löst aus:

ReportException - if the file can not be loaded or the format is currently not supported

Seit:

15.0

setDocumentOutput

public void setDocumentOutput(DocumentOutput documentOutput)

Set the output location for the rendered data. By default the memory (heap) is used. It is also possible to store the data into the report cache or stream it directly to an OutputStream. This must be set before call of execute().

Angegeben von:

setDocumentOutput in Schnittstelle ReportGenerator

Parameter:

documentOutput - The location for the data. This can be DocumentOutputStream or CachedOutput.

execute

public void execute()
             throws ReportException

See Engine.execute() for details.

Angegeben von:

execute in Schnittstelle ReportGenerator

Löst aus:

ReportException - if Engine is not initialized or finished.

Siehe auch:

• ReportGenerator.getPageData(int)

getEngine0

public Engine getEngine0()
                  throws ReportException

Get the first Engine from the bundle list.

Gibt zurück:

the Engine with index 0

Löst aus:

ReportException - if no rpt file was set.

Seit:

17.0

getEngines

public List<Engine> getEngines()

Get all Engines of this bundle.

Gibt zurück:

the engines

Seit:

17.0

getPageCount

public int getPageCount()
                 throws ReportException

See Engine.getPageCount() for details.

Angegeben von:

getPageCount in Schnittstelle ReportGenerator

Gibt zurück:

number of pages or chunks

Löst aus:

ReportException - If rendering the report encounters a problem

getPageData

public byte[] getPageData(int page)
                   throws ReportException

See Engine.getPageData(int) for details.

Angegeben von:

getPageData in Schnittstelle ReportGenerator

Parameter:

page - The number of the page. The first page is 1, the second is 2, ... . If the page number is bigger than the page count then null will be returned.

Gibt zurück:

the binary data for the Java Viewer or the bytes of the exported file (page).

Löst aus:

ReportException - If rendering the page encounters a problem

stop

public void stop(String message)

See Engine.stop(String) for details.

Angegeben von:

stop in Schnittstelle ReportGenerator

Parameter:

message - a message for the debug log.

getStatistics

public @Nonnull EngineStatistics getStatistics()

See Engine.getStatistics() for details.

Angegeben von:

getStatistics in Schnittstelle ReportGenerator

Gibt zurück:

the statistic

setUserProperties

public void setUserProperties(Properties props)
                       throws ReportException

See Engine.setUserProperties(Properties) for details.

Angegeben von:

setUserProperties in Schnittstelle ReportGenerator

Parameter:

props - The data to be set in a Properties object.

Löst aus:

ReportException - if Engine is not initialized or finished.

setClientLocale

public void setClientLocale(@Nonnull Locale locale)
                     throws ReportException

See Engine.setClientLocale(Locale) for details.

Angegeben von:

setClientLocale in Schnittstelle ReportGenerator

Parameter:

locale - The locale to be used by the client

Löst aus:

ReportException - if Engine is not initialized or finished.

stopAfterPage

public void stopAfterPage(int maxPageNo)

See Engine.stopAfterPage(int) for details.

Angegeben von:

stopAfterPage in Schnittstelle ReportGenerator

Parameter:

maxPageNo - The last page that should be rendered. 0 means "unlimited".

setPrompt

public void setPrompt(String name,
 String prompt)
               throws ReportException

See Engine.setPrompt(String, String) for details.

Angegeben von:

setPrompt in Schnittstelle ReportGenerator

Parameter:

name - the name of the parameter field

prompt - value for parameter field as String

Löst aus:

ReportException - if Engine is not initialized or finished.

getPromptField

public PromptField getPromptField(String name)
                           throws ReportException

See Engine.getPromptField(String) for details.

Angegeben von:

getPromptField in Schnittstelle ReportGenerator

Parameter:

name - name of the prompt to fetch

Gibt zurück:

PromptField by the given name in this Report, or null if none exists

Löst aus:

ReportException - if Engine is not initialized or finished.

setPrompt

public void setPrompt(String prompt,
 int i)
               throws ReportException

NOTE: Unlike Engine.setPrompt(String, int), the number i does not refer to prompt i in any engine, but will count from the first engine onwards. So if there are three engines with five prompts each, i=12 will set the third prompt in the third engine. See Engine.setPrompt(String, int) for details.

Angegeben von:

setPrompt in Schnittstelle ReportGenerator

Parameter:

prompt - value for parameter field i

i - index in the parameter list

Löst aus:

ReportException - if Engine is not initialized or finished.