|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.engine.api.ReportEngine
A report engine provides an entry point for reporting functionalities. It is where the report generation and rendering process are globally customized. It is also the place where engine statistics are collected. Through report engine, reports can be generated and rendered to different output formats. Queries can also be executed for preview purpose without involving a full report generation.
Engine supports running different types of tasks. Example tasks include running a report design to generate a report instance file, rendering a report instance to output format, running a report directly to output, running a dataset for preview, seaching a report, etc.
Field Summary | |
protected EngineConfig |
config
engine configuration object |
protected org.eclipse.birt.report.engine.api.impl.ReportEngineHelper |
helper
A helper object to carry out most ReportEngine jobs |
protected static java.util.logging.Logger |
logger
|
protected org.mozilla.javascript.ScriptableObject |
rootScope
root script scope. |
Constructor Summary | |
ReportEngine(EngineConfig config)
Constructor. |
Method Summary | |
void |
changeLogLevel(java.util.logging.Level newLevel)
Change the log level to newLevel |
IDataExtractionTask |
createDataExtractionTask(IReportDocument reportDocument)
creates a task that allows data extraction from a report document |
IDataPreviewTask |
createDataPreviewTask(IReportRunnable reportRunnable)
|
IGetParameterDefinitionTask |
createGetParameterDefinitionTask(IReportRunnable reportRunnable)
creates an engine task for obtaining report parameter definitions |
IRenderTask |
createRenderTask(IReportDocument reportDocument)
creates a task that renders the report to a specific output format. |
IRunAndRenderTask |
createRunAndRenderTask(IReportRunnable reportRunnable)
creates an engine task for running and rendering report directly to output format |
IRunTask |
createRunTask(IReportRunnable reportRunnable)
creates a task to run a report to generate a report document |
void |
destroy()
shuts down the report engine |
EngineConfig |
getConfig()
returns the engine configuration object |
java.lang.String |
getMIMEType(java.lang.String format)
the MIME type for the specific formatted supported by the extension. |
org.mozilla.javascript.ScriptableObject |
getRootScope()
get the root scope used by the engine |
java.lang.String[] |
getSupportedFormats()
returns all supported output formats through BIRT engine emitter extensions |
IReportRunnable |
openReportDesign(java.io.InputStream designStream)
opens a report design stream and creates a report design runnable. |
IReportRunnable |
openReportDesign(java.lang.String designName)
opens a report design file and creates a report design runnable. |
IReportRunnable |
openReportDesign(java.lang.String name,
java.io.InputStream designStream)
|
IReportDocument |
openReportDocument(java.lang.String fileName)
opens a report document and returns an IReportDocument object, from which further information can be retrieved. |
void |
shutdown()
shut down the engine, release all the resources. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static java.util.logging.Logger logger
protected EngineConfig config
protected org.eclipse.birt.report.engine.api.impl.ReportEngineHelper helper
protected org.mozilla.javascript.ScriptableObject rootScope
Constructor Detail |
public ReportEngine(EngineConfig config)
config
- an engine configuration object used to configure the engineMethod Detail |
public org.mozilla.javascript.ScriptableObject getRootScope()
public void changeLogLevel(java.util.logging.Level newLevel)
newLevel
- -
new log levelpublic EngineConfig getConfig()
public IReportRunnable openReportDesign(java.lang.String designName) throws EngineException
designName
- the full path of the report design file
EngineException
- throwed when the input file does not exist, or the file is
invalidpublic IReportRunnable openReportDesign(java.io.InputStream designStream) throws EngineException
designStream
- the report design input stream
EngineException
- throwed when the input stream is null, or the stream does not
yield a valid report designpublic IReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream) throws EngineException
EngineException
public IRunAndRenderTask createRunAndRenderTask(IReportRunnable reportRunnable)
reportRunnable
- the runnable report design object
public IGetParameterDefinitionTask createGetParameterDefinitionTask(IReportRunnable reportRunnable)
reportRunnable
- the runnable report design object
public IDataPreviewTask createDataPreviewTask(IReportRunnable reportRunnable)
public java.lang.String[] getSupportedFormats()
public java.lang.String getMIMEType(java.lang.String format)
format
- the output format
public void destroy()
public IRunTask createRunTask(IReportRunnable reportRunnable)
reportRunnable
- the runnable report design object
public IRenderTask createRenderTask(IReportDocument reportDocument)
reportDocument
- a handle to an IReportDocument object
public IReportDocument openReportDocument(java.lang.String fileName) throws EngineException
fileName
- the report document name. report document is an archive in
BIRT.
EngineException
- throwed when the report document archive does not exist, or
the file is not a valud report documentpublic IDataExtractionTask createDataExtractionTask(IReportDocument reportDocument)
reportDocument
- a handle to an IReportDocument object
public void shutdown()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |