|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.core.framework.PlatformConfig
org.eclipse.birt.report.engine.api.EngineConfig
public class 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 |
---|
Fields inherited from class org.eclipse.birt.core.framework.PlatformConfig |
---|
properties |
Fields inherited from interface org.eclipse.birt.report.engine.api.IEngineConfig |
---|
DEFAULT_RENDER_OPTION, EMITTER_CONFIGS, ENGINE_LOGGER, LOG_DESTINATION, LOG_FILE, LOG_LEVEL, MAX_ROWS_PER_QUERY, REPORT_DOCUMENT_LOCK_MANAGER, RESOURCE_LOCATOR, RESOURCE_PATH, SCRIPT_OBJECTS, STATUS_HANDLER, TEMP_DIR |
Fields inherited from interface org.eclipse.birt.core.framework.IPlatformConfig |
---|
BIRT_HOME, OSGI_ARGUMENTS, OSGI_CONFIGURATION, PLATFORM_CONTEXT |
Constructor Summary | |
---|---|
EngineConfig()
constructor |
Method Summary | |
---|---|
void |
addScriptableJavaObject(java.lang.String jsName,
java.lang.Object obj)
Deprecated. the user need add the object to the appContext directly. |
java.util.HashMap |
getAppContext()
returns a hash map that contains appContext |
java.util.HashMap |
getConfigMap()
Deprecated. use getProperties() instead. |
java.lang.String |
getDefualtEmitter(java.lang.String format)
Gets default emitter id of an output format. |
java.util.HashMap |
getEmitterConfigs()
gets a map for emitter configuration objects |
java.lang.String |
getLogDirectory()
Get directory of the log file |
java.lang.String |
getLogFile()
Get the name of the log file. |
java.util.logging.Logger |
getLogger()
return the user's logger set through setLogger. |
java.util.logging.Level |
getLogLevel()
Get the level of the log file |
int |
getMaxRowsPerQuery()
Deprecated. |
IReportDocumentLockManager |
getReportDocumentLockManager()
return a lock manager. |
org.eclipse.birt.report.model.api.IResourceLocator |
getResourceLocator()
|
java.lang.String |
getResourcePath()
|
java.util.HashMap |
getScriptObjects()
Deprecated. use getAppContext() instead. |
org.eclipse.birt.core.framework.IPlatformContext |
getServletContext()
Deprecated. use getPlatformContext instead |
IStatusHandler |
getStatusHandler()
returns the status handler |
java.lang.String |
getTempDir()
returns engine temporary directory for temporary files |
void |
setAppContext(java.util.HashMap appContext)
Set appContext |
void |
setConfigurationVariable(java.lang.String name,
java.lang.String value)
Deprecated. use setProperty() instead. |
void |
setDefualtEmitter(java.lang.String format,
java.lang.String emitterId)
Sets default emitter for an output format. |
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)
Deprecated. use setPlatformContext instead. |
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 |
setLogFile(java.lang.String filename)
Set the name of the log file. |
void |
setLogger(java.util.logging.Logger logger)
set the logger used by the report engine. |
void |
setMaxRowsPerQuery(int maxRows)
Deprecated. |
void |
setReportDocumentLockManager(IReportDocumentLockManager manager)
Set report document lock manager |
void |
setResourceLocator(org.eclipse.birt.report.model.api.IResourceLocator resourceLocator)
|
void |
setResourcePath(java.lang.String resourcePath)
|
void |
setStatusHandler(IStatusHandler handler)
sets the handler for reporting report running status. |
void |
setTempDir(java.lang.String tmpDir)
sets the directory for temporary files |
java.lang.String |
toString()
Output properties for debug tracing |
Methods inherited from class org.eclipse.birt.core.framework.PlatformConfig |
---|
getBIRTHome, getOSGiArguments, getOSGiConfig, getPlatformContext, getProperties, getProperty, setBIRTHome, setOSGiArguments, setOSGiConfig, setPlatformContext, setProperty |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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 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 void setLogger(java.util.logging.Logger logger)
logger
- public java.util.logging.Logger getLogger()
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 java.util.HashMap getAppContext()
public void setAppContext(java.util.HashMap appContext)
appContext
- public void setEmitterConfiguration(java.lang.String format, java.lang.Object emitterConfig)
extensionID
- identifier for the emitterextensionConfig
- configuration object for the emitter, which must be an
instance of HashMap or IRenderOptionpublic java.util.HashMap getEmitterConfigs()
public IStatusHandler getStatusHandler()
public void setStatusHandler(IStatusHandler handler)
handler
- status handlerpublic java.util.logging.Level getLogLevel()
public java.lang.String getLogDirectory()
public java.lang.String getLogFile()
public void setLogFile(java.lang.String filename)
filename
- public void setTempDir(java.lang.String tmpDir)
tmpDir
- the directory for temporary filespublic java.lang.String getTempDir()
public IReportDocumentLockManager getReportDocumentLockManager()
public void setReportDocumentLockManager(IReportDocumentLockManager manager)
manager
- lock managerpublic void setEngineContext(org.eclipse.birt.core.framework.IPlatformContext context)
context
- the platform contextpublic org.eclipse.birt.core.framework.IPlatformContext getServletContext()
public org.eclipse.birt.report.model.api.IResourceLocator getResourceLocator()
public void setResourceLocator(org.eclipse.birt.report.model.api.IResourceLocator resourceLocator)
resourceLocator
- the resourceLocator to setpublic java.lang.String getResourcePath()
public void setResourcePath(java.lang.String resourcePath)
resourcePath
- the resourcePath to setpublic void setMaxRowsPerQuery(int maxRows)
maxRows:
- max rowspublic int getMaxRowsPerQuery()
public void setDefualtEmitter(java.lang.String format, java.lang.String emitterId)
format
- the format.emitterId
- the id of the default emitter.public java.lang.String getDefualtEmitter(java.lang.String format)
format
- the format.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |