|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.engine.api.EngineConfig
Wraps around configuration settings for report engine. Allows developers to specify where to look for engine plugins, data drivers, and where to write image files. Allows users to customize data-related properties (i.e., data engine). Also allows engine to provide customized implementations for image handling, hyperlink handling and font handling, etc.
Field Summary | |
static java.lang.String |
CONFIG_VAR_ENGINE_HOME
|
protected java.util.HashMap |
configObjects
stores various configuration objects |
protected org.eclipse.birt.core.framework.IPlatformContext |
context
the context that the platform is running. |
protected java.util.HashMap |
emitterConfigs
store emitter configuration |
protected static java.lang.String |
LOG_DESTINATION
|
protected static java.lang.String |
LOG_LEVEL
|
protected java.util.HashMap |
scriptObjects
stores app-wide, app-specific JS scriptable objects |
protected IStatusHandler |
statusHandler
default status handler |
protected static java.lang.String |
TEMP_DIR
|
Constructor Summary | |
EngineConfig()
constructor |
Method Summary | |
void |
addScriptableJavaObject(java.lang.String jsName,
java.lang.Object obj)
defines an additional Java object that is exposed to BIRT scripting |
java.util.HashMap |
getConfigMap()
returns a hash map that contains all the configuration objects |
java.util.HashMap |
getEmitterConfigs()
gets a map for emitter configuration objects |
java.util.HashMap |
getScriptObjects()
returns a hash map that contains all the app-specific, app-wide scriptable Java objects |
org.eclipse.birt.core.framework.IPlatformContext |
getServletContext()
|
IStatusHandler |
getStatusHandler()
returns the status handler |
java.lang.String |
getTempDir()
returns engine temporary directory for temporary files |
void |
setConfigurationVariable(java.lang.String name,
java.lang.String value)
sets a configuration variable that is available through scripting in engine |
void |
setEmitterConfiguration(java.lang.String format,
java.lang.Object emitterConfig)
sets configuration for a specific extension to engine, i.e., an emitter extension |
void |
setEngineContext(org.eclipse.birt.core.framework.IPlatformContext context)
|
void |
setEngineHome(java.lang.String birtHome)
set the BIRT_HOME system property |
void |
setLogConfig(java.lang.String directoryName,
java.util.logging.Level level)
set log configuration, i.e., log file name prefix and log level |
void |
setStatusHandler(IStatusHandler handler)
sets the handler for reporting report running status. |
void |
setTempDir(java.lang.String tmpDir)
sets the directory for temporary files |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String CONFIG_VAR_ENGINE_HOME
protected static final java.lang.String LOG_DESTINATION
protected static final java.lang.String LOG_LEVEL
protected static final java.lang.String TEMP_DIR
protected java.util.HashMap configObjects
protected java.util.HashMap scriptObjects
protected java.util.HashMap emitterConfigs
protected IStatusHandler statusHandler
protected org.eclipse.birt.core.framework.IPlatformContext context
Constructor Detail |
public EngineConfig()
Method Detail |
public void setEngineHome(java.lang.String birtHome)
birtHome
- the value for the BIRT_HOMT configuration variablepublic void setConfigurationVariable(java.lang.String name, java.lang.String value)
name
- configuration variable namevalue
- configuration variable valuepublic java.util.HashMap getConfigMap()
public java.util.HashMap getScriptObjects()
public void addScriptableJavaObject(java.lang.String jsName, java.lang.Object obj)
jsName
- the name that the object is referenced in JavaScriptobj
- the Java object that is wrapped and scriptedpublic void setEmitterConfiguration(java.lang.String format, java.lang.Object emitterConfig)
public void setStatusHandler(IStatusHandler handler)
handler
- status handlerpublic IStatusHandler getStatusHandler()
public void setLogConfig(java.lang.String directoryName, java.util.logging.Level level)
directoryName
- - the directory name of the log file(e.g C:\Log).
Engine appends a file name with date and time to the directory name (e.g. C:\Log\BIRT_Engine_2005_02_26_11_26_56.log).level
- the engine log levelpublic java.util.HashMap getEmitterConfigs()
public void setTempDir(java.lang.String tmpDir)
tmpDir
- the directory for temporary filespublic java.lang.String getTempDir()
public void setEngineContext(org.eclipse.birt.core.framework.IPlatformContext context)
public org.eclipse.birt.core.framework.IPlatformContext getServletContext()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |