Interface IReportRunnable
- All Superinterfaces:
IRunnable
A runnable report design (i.e., not modifiable) that can be run in the BIRT
engine
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionorg.eclipse.birt.report.model.api.DesignElementHandle
returns the design element handle that design engine creates when opening the reportorg.eclipse.birt.report.engine.api.script.element.IReportDesign
Returns the report designreturns an image stored in a report design file, or null if the image name does not existgetProperty
(String propertyName) returns the property value for things like report description, title, etc.getProperty
(String path, String propertyName) Deprecated.this method is never used ,suggest use Model API to access all properties on elements.returns the report enginereturns report namereturns test configuration for the reportvoid
setDesignHandle
(org.eclipse.birt.report.model.api.DesignElementHandle handle) sets a new report design handle before rendering the report
-
Field Details
-
TITLE
- See Also:
-
AUTHOR
- See Also:
-
DESCRIPTION
- See Also:
-
COMMENTS
- See Also:
-
CREATEDBY
- See Also:
-
HELP_GUIDE
- See Also:
-
BASE_PROP
- See Also:
-
UNITS
- See Also:
-
REFRESH_RATE
- See Also:
-
-
Method Details
-
getImage
returns an image stored in a report design file, or null if the image name does not exist- Parameters:
name
- the image name for the embedded image
-
getProperty
returns the property value for things like report description, title, etc.- Parameters:
propertyName
- the name of the property- Returns:
- the property value for things like report description, title, etc.
-
getProperty
Deprecated.this method is never used ,suggest use Model API to access all properties on elements.returns the property value defined on a components in a report design. For example, getProperty("/dataSets/dsName", "url") will return the url value for a data set with name dsName.- Parameters:
propertyName
- the name of the propertypath
- a simplified XPath that allows access to properties for components in a report design. Only downward path is allowed, i.e., no .. in the path.- Returns:
- the property value for things like report description, title, etc.
-
getDesignHandle
org.eclipse.birt.report.model.api.DesignElementHandle getDesignHandle()returns the design element handle that design engine creates when opening the report- Returns:
- the design element handle that design engine creates when opening the report
-
setDesignHandle
void setDesignHandle(org.eclipse.birt.report.model.api.DesignElementHandle handle) sets a new report design handle before rendering the report- Parameters:
handle
- a new report design handle
-
getReportName
String getReportName()returns report name- Returns:
- the name of the report
-
getTestConfig
HashMap getTestConfig()returns test configuration for the report- Returns:
- test configurations for the report
-
getReportEngine
IReportEngine getReportEngine()returns the report engine- Returns:
- the report engine
-
getDesignInstance
org.eclipse.birt.report.engine.api.script.element.IReportDesign getDesignInstance()Returns the report design- Returns:
- the report design
-