public class BirtManager
extends java.lang.Object
All the settling phase for the engine and the launch of the its elaboration on a Report design document are made here. The context being searched by the engine for a named report design document, is defined in the application configuration file, and even the target directories for the output of the engine are defined there.
The class is instantiated either by the Joty Server or by the Application
object
depending on the application running in web mode or not.
buildReport
is the most significant method.
buildReport(String, String, boolean)
Modifier and Type | Field and Description |
---|---|
java.lang.String |
m_exception |
java.lang.String |
m_rptDesignsPath |
java.lang.String |
m_rptDocumentsPath |
java.lang.String |
m_rptLogsPath |
java.lang.String |
m_rptOutputsPath |
Constructor and Description |
---|
BirtManager(org.joty.common.ReportManager reportManager) |
BirtManager(org.joty.common.ReportManager reportManager,
java.lang.Object app) |
Modifier and Type | Method and Description |
---|---|
void |
appInit() |
protected org.eclipse.birt.report.engine.api.IRenderOption |
buildOptions(java.lang.String reportName,
java.lang.String renderType) |
void |
buildReport(java.lang.String name,
java.lang.String renderType,
boolean twoProcess)
This method supports either the one process mode or the two process mode
offered by the BIRT Engine.
|
protected org.eclipse.birt.report.engine.api.IEngineTask |
createTaskOnDesign(java.lang.String reportName,
boolean forAnOnlyProcess) |
void |
end() |
void |
init() |
void |
init(java.lang.String designsPath,
java.lang.String documentsPath,
java.lang.String outputsPath,
java.lang.String logsPath) |
boolean |
initied() |
void |
manageException(java.lang.Exception e) |
java.lang.String |
outputFileDir() |
boolean |
renderReport(java.lang.String reportName,
java.lang.String renderType) |
boolean |
runAndRenderReport(java.lang.String reportName,
java.lang.String renderType) |
boolean |
runReport(java.lang.String reportName) |
boolean |
runThenRenderReport(java.lang.String reportName,
java.lang.String renderType) |
void |
setDbUrl(java.lang.String dbUrl) |
void |
setJdbcDriverClass(java.lang.String jdbcDriverClass) |
void |
setLanguage(java.lang.String language) |
void |
setPassword(java.lang.String password) |
void |
setRealPath(java.lang.String path) |
void |
setUser(java.lang.String user) |
public java.lang.String m_rptDesignsPath
public java.lang.String m_rptDocumentsPath
public java.lang.String m_rptOutputsPath
public java.lang.String m_rptLogsPath
public java.lang.String m_exception
public BirtManager(org.joty.common.ReportManager reportManager, java.lang.Object app)
public BirtManager(org.joty.common.ReportManager reportManager)
public void appInit()
protected org.eclipse.birt.report.engine.api.IRenderOption buildOptions(java.lang.String reportName, java.lang.String renderType)
public void buildReport(java.lang.String name, java.lang.String renderType, boolean twoProcess)
name
- the name of the report as it will be searched by the BIRT
Engine in the file-system (a part from the extension)renderType
- one value chosen among the following { "pdf", "html", "ods",
"xls", "ppt", "doc" }twoProcess
- if true the Birt Engine is requested to run in two distinct
phases: 'run' with the production of an intermediate and final
document object and then 'render' where the engine works only
for the presentation of the output. (see the BIRT Report Engine documentation)BirtManager
protected org.eclipse.birt.report.engine.api.IEngineTask createTaskOnDesign(java.lang.String reportName, boolean forAnOnlyProcess)
public void end()
public void init()
public void init(java.lang.String designsPath, java.lang.String documentsPath, java.lang.String outputsPath, java.lang.String logsPath)
public boolean initied()
public void manageException(java.lang.Exception e)
public java.lang.String outputFileDir()
public boolean renderReport(java.lang.String reportName, java.lang.String renderType)
public boolean runAndRenderReport(java.lang.String reportName, java.lang.String renderType)
public boolean runReport(java.lang.String reportName)
public boolean runThenRenderReport(java.lang.String reportName, java.lang.String renderType)
public void setDbUrl(java.lang.String dbUrl)
public void setJdbcDriverClass(java.lang.String jdbcDriverClass)
public void setLanguage(java.lang.String language)
public void setPassword(java.lang.String password)
public void setRealPath(java.lang.String path)
public void setUser(java.lang.String user)