Difference between revisions of "Appcontext params"

From Eclipsepedia

Jump to: navigation, search
(New page: Available Appcontext() Parameters <br> <br> {| cellspacing="1" cellpadding="1" border="1" style="width: 775px; height: 276px;" |- | '''Component<br>''' | '''Key'''<br> | '''Usage'''<br> ...)
 
 
(3 intermediate revisions by one user not shown)
Line 1: Line 1:
Available Appcontext() Parameters <br>
+
This page documents the available keys for Appcontext() Parameters.<br>  
  
<br>
+
{| cellspacing="1" cellpadding="1" border="1" style="width: 1080px; height: 889px;"
 
+
{| cellspacing="1" cellpadding="1" border="1" style="width: 775px; height: 276px;"
+
 
|-
 
|-
| '''Component<br>'''
+
| '''Component<br>'''  
| '''Key'''<br>
+
| '''Key'''<br>  
 
| '''Usage'''<br>
 
| '''Usage'''<br>
 
|-
 
|-
| rowspan="3" | '''JDBC Datasource (org.eclipse.birt.report.data.oda.jdbc)'''<br>
+
| rowspan="3" | '''JDBC Datasource (org.eclipse.birt.report.data.oda.jdbc)'''<br>  
| IConnectionFactory.DRIVER_CLASSPATH<br>
+
| IConnectionFactory.DRIVER_CLASSPATH<br>  
 
| Can be used to manually set the driver classpath that the JDBC plugin uses to locate a driver. <br>
 
| Can be used to manually set the driver classpath that the JDBC plugin uses to locate a driver. <br>
 
|-
 
|-
| IConnectionFactory.PASS_IN_CONNCTION<br>
+
| IConnectionFactory.PASS_IN_CONNCTION<br>  
 
| Can be used to manually pass in a JDBC connect to be used by the JDBC plugin.<br>
 
| Can be used to manually pass in a JDBC connect to be used by the JDBC plugin.<br>
 
|-
 
|-
| IConnectionFactory.CLOSE_PASS_IN_CONNECTION<br>
+
| IConnectionFactory.CLOSE_PASS_IN_CONNECTION<br>  
 
| Manually set whether the JDBC connections is closed after usage by the plugin. Defaults to true.<br>
 
| Manually set whether the JDBC connections is closed after usage by the plugin. Defaults to true.<br>
 
|-
 
|-
| rowspan="2" | '''XML Data Source (org.eclipse.datatools.enablement.oda.xml)'''<br>
+
| rowspan="2" | '''XML Data Source (org.eclipse.datatools.enablement.oda.xml)'''<br>  
| Constants.APPCONTEXT_INPUTSTREAM<br>
+
| Constants.APPCONTEXT_INPUTSTREAM<br>  
 
| Sets the InputStream for an XML Datasource. Example ByteArrayInputStream.<br>
 
| Sets the InputStream for an XML Datasource. Example ByteArrayInputStream.<br>
 
|-
 
|-
| Constants.APPCONTEXT_CLOSEINPUTSTREAM<br>
+
| Constants.APPCONTEXT_CLOSEINPUTSTREAM<br>  
 
| Close XML InputStream after it is used.(true or false)<br>
 
| Close XML InputStream after it is used.(true or false)<br>
 
|-
 
|-
| Data Engine (org.eclipse.birt.data.engine.api)<br>
+
| rowspan="3" | '''<br> Data Engine (org.eclipse.birt.data.engine.api)'''<br>  
| DataEngine.DATA_SET_CACHE_ROW_LIMIT<br>
+
| DataEngine.DATA_SET_CACHE_ROW_LIMIT<br>  
 
|  
 
|  
 
This settings allows user to cache a data set in disk. If set to negative value, all rows in dataset will be cached. If set to zero, the function is disabled. If set to positive number, specific number of rows will be cached. Should only be used in a design situation.  
 
This settings allows user to cache a data set in disk. If set to negative value, all rows in dataset will be cached. If set to zero, the function is disabled. If set to positive number, specific number of rows will be cached. Should only be used in a design situation.  
  
Change setting to clear.
+
Change setting to clear.  
  
 
|-
 
|-
| <br>
+
| DataEngine.MEMORY_BUFFER_SIZE<br>  
| DataEngine.MEMORY_BUFFER_SIZE<br>
+
 
| Memory per Query that is used before caching to disk. Defaults to 10MB. Used inside and outside of designer.<br>
 
| Memory per Query that is used before caching to disk. Defaults to 10MB. Used inside and outside of designer.<br>
 
|-
 
|-
| <br>
+
| DataEngine.MEMORY_DATA_SET_CACHE<br>  
| DataEngine.MEMORY_DATA_SET_CACHE<br>
+
|  
| Change setting to clear<br>
+
This setting allows user to cache a data set in memory. If Set to a number equal or less than zero, the function is disabled. If set to a positive number, exactly that number of rows will be saved to memory. Should only be used in a design situation.
 +
 
 +
Change setting to clear  
 +
 
 +
|-
 +
| rowspan="7" | '''Report Engine (org.eclipse.birt.report.engine.api)'''<br>
 +
| EngineConstants.APPCONTEXT_BIRT_VIEWER_HTTPSERVET_REQUEST<br>
 +
| Used to load the request object into the scripting context for use in report scripting.<br>
 +
|-
 +
| EngineConstants.APPCONTEXT_CLASSLOADER_KEY<br>
 +
| Used to set the parent classloader for the report engine<br>
 +
|-
 +
| EngineConstants.APPCONTEXT_CHART_RESOLUTION<br>
 +
| Used to set the chart resolution in dpi. Defaults to 96 dpi.<br>
 +
|-
 +
| EngineConstants.PROPERTY_EXTENDED_ITEM_MAX_ROW<br>
 +
| Max number of rows a chart report item will process. Defaults to 0 meaning no limit.<br>
 +
|-
 +
| EngineConstants.WEBAPP_CLASSPAH_KEY<br>
 +
| Additional classpath setup internally for viewer. Can be used by API.<br>
 +
|-
 +
| EngineConstants.WORKSPACE_CLASSPATH_KEY<br>
 +
| Additional classpath setup internally for workspace. Can be used by API.<br>
 
|-
 
|-
| <br>
+
| EngineConstants.PROJECT_CLASSPATH_KEY<br>  
| <br>
+
| Additional classpath setup internally for project. Can be used by API.<br>
| <br>
+
 
|}
 
|}
  
 
<br>
 
<br>

Latest revision as of 05:43, 25 March 2011

This page documents the available keys for Appcontext() Parameters.

Component
Key
Usage
JDBC Datasource (org.eclipse.birt.report.data.oda.jdbc)
IConnectionFactory.DRIVER_CLASSPATH
Can be used to manually set the driver classpath that the JDBC plugin uses to locate a driver.
IConnectionFactory.PASS_IN_CONNCTION
Can be used to manually pass in a JDBC connect to be used by the JDBC plugin.
IConnectionFactory.CLOSE_PASS_IN_CONNECTION
Manually set whether the JDBC connections is closed after usage by the plugin. Defaults to true.
XML Data Source (org.eclipse.datatools.enablement.oda.xml)
Constants.APPCONTEXT_INPUTSTREAM
Sets the InputStream for an XML Datasource. Example ByteArrayInputStream.
Constants.APPCONTEXT_CLOSEINPUTSTREAM
Close XML InputStream after it is used.(true or false)

Data Engine (org.eclipse.birt.data.engine.api)

DataEngine.DATA_SET_CACHE_ROW_LIMIT

This settings allows user to cache a data set in disk. If set to negative value, all rows in dataset will be cached. If set to zero, the function is disabled. If set to positive number, specific number of rows will be cached. Should only be used in a design situation.

Change setting to clear.

DataEngine.MEMORY_BUFFER_SIZE
Memory per Query that is used before caching to disk. Defaults to 10MB. Used inside and outside of designer.
DataEngine.MEMORY_DATA_SET_CACHE

This setting allows user to cache a data set in memory. If Set to a number equal or less than zero, the function is disabled. If set to a positive number, exactly that number of rows will be saved to memory. Should only be used in a design situation.

Change setting to clear

Report Engine (org.eclipse.birt.report.engine.api)
EngineConstants.APPCONTEXT_BIRT_VIEWER_HTTPSERVET_REQUEST
Used to load the request object into the scripting context for use in report scripting.
EngineConstants.APPCONTEXT_CLASSLOADER_KEY
Used to set the parent classloader for the report engine
EngineConstants.APPCONTEXT_CHART_RESOLUTION
Used to set the chart resolution in dpi. Defaults to 96 dpi.
EngineConstants.PROPERTY_EXTENDED_ITEM_MAX_ROW
Max number of rows a chart report item will process. Defaults to 0 meaning no limit.
EngineConstants.WEBAPP_CLASSPAH_KEY
Additional classpath setup internally for viewer. Can be used by API.
EngineConstants.WORKSPACE_CLASSPATH_KEY
Additional classpath setup internally for workspace. Can be used by API.
EngineConstants.PROJECT_CLASSPATH_KEY
Additional classpath setup internally for project. Can be used by API.