|
||||||||||
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
public class ReportEngine
This is a wrapper class for the IReportEngine. The new user should use the IReportEngineFactory to create the IReportEngine instead of use this class directly.
org.eclipes.birt.report.engine.api.ReportRunner
Field Summary | |
---|---|
protected IReportEngine |
engine
the report engine. |
protected static java.util.logging.Logger |
logger
the logger |
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 |
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()
shuts down the report engine |
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 reader,
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 by report engine. |
void |
shutdown()
Deprecated. |
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 IReportEngine engine
Constructor Detail |
---|
public ReportEngine(EngineConfig config)
config
- an engine configuration object used to configure the engineMethod Detail |
---|
public java.lang.Object getRootScope()
getRootScope
in interface IReportEngine
public void changeLogLevel(java.util.logging.Level newLevel)
changeLogLevel
in interface IReportEngine
newLevel
- -
new log levelpublic EngineConfig getConfig()
getConfig
in interface IReportEngine
public IReportRunnable openReportDesign(java.lang.String designName) throws EngineException
openReportDesign
in interface IReportEngine
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(org.eclipse.birt.report.model.api.ReportDesignHandle designHandle) throws EngineException
openReportDesign
in interface IReportEngine
designHandle
-
EngineException
public IReportRunnable openReportDesign(java.io.InputStream designStream) throws EngineException
openReportDesign
in interface IReportEngine
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
openReportDesign
in interface IReportEngine
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 designpublic IRunAndRenderTask createRunAndRenderTask(IReportRunnable reportRunnable)
createRunAndRenderTask
in interface IReportEngine
reportRunnable
- the runnable report design object
public IGetParameterDefinitionTask createGetParameterDefinitionTask(IReportRunnable reportRunnable)
createGetParameterDefinitionTask
in interface IReportEngine
reportRunnable
- the runnable report design object
public java.lang.String[] getSupportedFormats()
getSupportedFormats
in interface IReportEngine
public EmitterInfo[] getEmitterInfo()
getEmitterInfo
in interface IReportEngine
public java.lang.String getMIMEType(java.lang.String format)
getMIMEType
in interface IReportEngine
format
- the output formatextensionID
- the extension ID, which could be null if only one plugin
supports the output format
public void destroy()
destroy
in interface IReportEngine
public IRunTask createRunTask(IReportRunnable reportRunnable)
createRunTask
in interface IReportEngine
reportRunnable
- the runnable report design object
public IRenderTask createRenderTask(IReportDocument reportDocument)
createRenderTask
in interface IReportEngine
reportDocument
- a handle to an IReportDocument object
public IReportDocument openReportDocument(java.lang.String fileName) throws EngineException
openReportDocument
in interface IReportEngine
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)
createDataExtractionTask
in interface IReportEngine
reportDocument
- a handle to an IReportDocument object
public void shutdown()
shutdown
in interface IReportEngine
public IReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName) throws EngineException
openReportDocument
in interface IReportEngine
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 documentpublic IReportRunnable openReportDesign(java.lang.String designName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
openReportDesign
in interface IReportEngine
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
invalidpublic IReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
openReportDesign
in interface IReportEngine
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 designpublic IReportRunnable openReportDesign(java.lang.String name, java.io.InputStream designStream, java.util.Map options) throws EngineException
openReportDesign
in interface IReportEngine
name
- system id of the report design.designStream
- input stream of the report desgin.options
- options used to parse the design.
EngineException
ModelOptions
public IReportDocument openReportDocument(java.lang.String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
openReportDocument
in interface IReportEngine
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 documentpublic IReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName, org.eclipse.birt.report.model.api.IResourceLocator locator) throws EngineException
openReportDocument
in interface IReportEngine
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 documentpublic IReportDocument openReportDocument(java.lang.String systemId, java.lang.String fileName, java.util.Map options) throws EngineException
openReportDocument
in interface IReportEngine
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 defines the options used to parse the design file.
EngineException
- throwed when the report document archive does not exist, or
the file is not a valid report documentpublic IReportDocument openReportDocument(java.lang.String systemId, org.eclipse.birt.core.archive.IDocArchiveReader reader, java.util.Map options) throws EngineException
openReportDocument
in interface IReportEngine
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.reader
- a report archive for readingoptions
- Map defines the options used to parse the design file.
EngineException
- throwed when the report document archive does not exist, or
the file is not a valid report documentpublic java.util.logging.Logger getLogger()
getLogger
in interface IReportEngine
public void setLogger(java.util.logging.Logger logger)
setLogger
in interface IReportEngine
logger
- public IRenderTask createRenderTask(IReportDocument reportDocument, IReportRunnable reportRunnable)
createRenderTask
in interface IReportEngine
reportDocument
- a handle to an IReportDocument objectreportRunnable
- the runnable report design object
public DataExtractionFormatInfo[] getDataExtractionFormatInfo()
getDataExtractionFormatInfo
in interface IReportEngine
public IDocumentWriter openDocumentWriter(org.eclipse.birt.core.archive.compound.IArchiveFile file) throws EngineException
openDocumentWriter
in interface IReportEngine
file
- the archive file
EngineException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |