|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportEngine
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 data set for preview, searching a report, etc.
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. |
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. |
IRenderTask |
createRenderTask(IReportDocument reportDocument,
IReportRunnable reportRunnable)
Create 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()
Shut down the engine, release all the resources. |
EngineConfig |
getConfig()
Returns the engine configuration object. |
DataExtractionFormatInfo[] |
getDataExtractionFormatInfo()
Returns data extraction extension information. |
EmitterInfo[] |
getEmitterInfo()
Return all the emitter information which BIRT Engine can load. |
java.util.logging.Logger |
getLogger()
Get the logger used by report engine. |
java.lang.String |
getMIMEType(java.lang.String format)
The MIME type for the specific formatted supported by the extension. |
java.lang.Object |
getRootScope()
Get the root scope used by the engine. |
java.lang.String[] |
getSupportedFormats()
Returns all supported output formats through BIRT engine emitter extensions. |
IDocumentWriter |
openDocumentWriter(org.eclipse.birt.core.archive.compound.IArchiveFile file)
creates a document writer that can write this archive file |
IReportRunnable |
openReportDesign(java.io.InputStream designStream)
Opens a report design stream and creates a report design runnable. |
IReportRunnable |
openReportDesign(org.eclipse.birt.report.model.api.ReportDesignHandle designHandle)
Opens a report designHandle 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)
Opens a report design stream and creates a report design runnable. |
IReportRunnable |
openReportDesign(java.lang.String name,
java.io.InputStream designStream,
org.eclipse.birt.report.model.api.IResourceLocator locator)
Opens a report design stream and creates a report design runnable. |
IReportRunnable |
openReportDesign(java.lang.String name,
java.io.InputStream designStream,
java.util.Map options)
Open the report design and return the runnable. |
IReportRunnable |
openReportDesign(java.lang.String designName,
org.eclipse.birt.report.model.api.IResourceLocator locator)
Opens a report design file and creates a report design runnable. |
IReportDocument |
openReportDocument(java.lang.String fileName)
Opens a report document and returns an IReportDocument object, from which further information can be retrieved. |
IReportDocument |
openReportDocument(java.lang.String systemId,
org.eclipse.birt.core.archive.IDocArchiveReader archiveReader,
java.util.Map options)
Opens a report document and returns an IReportDocument object, from which further information can be retrieved. |
IReportDocument |
openReportDocument(java.lang.String fileName,
org.eclipse.birt.report.model.api.IResourceLocator locator)
Opens a report document and returns an IReportDocument object, from which further information can be retrieved. |
IReportDocument |
openReportDocument(java.lang.String systemId,
java.lang.String fileName)
Opens a report document and returns an IReportDocument object, from which further information can be retrieved. |
IReportDocument |
openReportDocument(java.lang.String systemId,
java.lang.String fileName,
org.eclipse.birt.report.model.api.IResourceLocator locator)
Opens a report document and returns an IReportDocument object, from which further information can be retrieved. |
IReportDocument |
openReportDocument(java.lang.String systemId,
java.lang.String fileName,
java.util.Map options)
Opens a report document and returns an IReportDocument object, from which further information can be retrieved. |
void |
setLogger(java.util.logging.Logger logger)
Set the logger used the engine. |
void |
shutdown()
Deprecated. Use destroy() instead. |
Method Detail |
---|
java.lang.Object getRootScope()
void changeLogLevel(java.util.logging.Level newLevel)
newLevel
- -
new log levelvoid setLogger(java.util.logging.Logger logger)
logger
- java.util.logging.Logger getLogger()
EngineConfig getConfig()
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
invalidIReportRunnable openReportDesign(java.lang.String designName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
designName
- the full path of the report design filelocator
- the resource locator used to locate files referenced in the design
EngineException
- throwed when the input file does not exist, or the file is
invalidIReportRunnable openReportDesign(org.eclipse.birt.report.model.api.ReportDesignHandle designHandle) throws EngineException
designHandle
-
EngineException
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 designIReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream) throws EngineException
name
- system id of the report designdesignStream
- input stream of the report design
EngineException
- throwed when the input stream is null, or the stream does not
yield a valid report designIReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
name
- system id of the report designdesignStream
- input stream of the report designlocator
- the resource locator used to locate files referenced in the design
EngineException
- throwed when the input stream is null, or the stream does not
yield a valid report designIReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream, java.util.Map options) throws EngineException
name
- system id of the report design.designStream
- stream of the report desgin.options
- options used to parse the design.
EngineException
ModelOptions
IRunAndRenderTask createRunAndRenderTask(IReportRunnable reportRunnable)
reportRunnable
- the runnable report design object
IGetParameterDefinitionTask createGetParameterDefinitionTask(IReportRunnable reportRunnable)
reportRunnable
- the runnable report design object
java.lang.String[] getSupportedFormats()
EmitterInfo[] getEmitterInfo()
DataExtractionFormatInfo[] getDataExtractionFormatInfo()
java.lang.String getMIMEType(java.lang.String format)
format
- the output formatextensionID
- the extension ID, which could be null if only one plugin
supports the output format
void destroy()
IRunTask createRunTask(IReportRunnable reportRunnable)
reportRunnable
- the runnable report design object
IRenderTask createRenderTask(IReportDocument reportDocument, IReportRunnable reportRunnable)
reportDocument
- a handle to an IReportDocument objectreportRunnable
- the runnable report design object
IRenderTask createRenderTask(IReportDocument reportDocument)
reportDocument
- a handle to an IReportDocument object
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 documentIReportDocument openReportDocument(java.lang.String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
fileName
- the report document name. report document is an archive in
BIRT.locator
- the resource locator used to locate files referenced in the design
EngineException
- throwed when the report document archive does not exist, or
the file is not a valud report documentIReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName) throws EngineException
systemId
- the system id the opend document. It is used to access the resources with
relative path in the report document. If it is NULL, a saved one is used.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 valid report documentIReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
systemId
- the system id the opend document. It is used to access the resources with
relative path in the report document. If it is NULL, a saved one is used.fileName
- the report document name. report document is an archive in
BIRT.locator
- the resource locator used to locate files referenced in the design
EngineException
- throwed when the report document archive does not exist, or
the file is not a valud report documentIReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName, java.util.Map options) throws EngineException
systemId
- the system id the opend document. It is used to access the resources with
relative path in the report document. If it is NULL, a saved one is used.fileName
- the report document name. report document is an archive in
BIRT.options
- Map defins the options used to parse the design file.
EngineException
- throwed when the report document archive does not exist, or
the file is not a valud report documentIReportDocument openReportDocument(java.lang.String systemId, org.eclipse.birt.core.archive.IDocArchiveReader archiveReader, java.util.Map options) throws EngineException
systemId
- the system id the opend document. It is used to access the resources with
relative path in the report document. If it is NULL, a saved one is used.archiveReader
- a report archive for readingoptions
- Map defins the options used to parse the design file.
EngineException
- throwed when the report document archive does not exist, or
the file is not a valud report documentIDataExtractionTask createDataExtractionTask(IReportDocument reportDocument)
reportDocument
- a handle to an IReportDocument object
void shutdown()
IDocumentWriter openDocumentWriter(org.eclipse.birt.core.archive.compound.IArchiveFile file) throws EngineException
file
- the archive file
EngineException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |