|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportItemGeneration
Represents the extended item generation extension, which processes the report item at report geenration time.
Method Summary | |
---|---|
void |
finish()
Performs clean up work |
IReportItemGenerationInfo |
getGenerationConfig()
|
org.eclipse.birt.report.engine.extension.Size |
getSize()
Get the size of the extended item. |
void |
init(IReportItemGenerationInfo info)
|
boolean |
needSerialization()
returns whether the extended item needs serialization of state information at generation time |
void |
onRowSets(IBaseResultSet[] results)
processes the extended item in report generation environment. |
void |
onRowSets(IRowSet[] rowSets)
Deprecated. since BIRT 2.3 |
void |
serialize(java.io.OutputStream ostream)
serializes the extended item generation time state. |
void |
setApplicationClassLoader(java.lang.ClassLoader loader)
Deprecated. implement #init(IReportItemGenerationInfo) instead |
void |
setExtendedItemContent(IContent content)
Deprecated. implement #init(IReportItemGenerationInfo) instead |
void |
setModelObject(org.eclipse.birt.report.model.api.ExtendedItemHandle modelHandle)
Deprecated. implement #init(IReportItemGenerationInfo) instead |
void |
setReportQueries(org.eclipse.birt.data.engine.api.IDataQueryDefinition[] queries)
Deprecated. implement #init(IReportItemGenerationInfo) instead |
void |
setScriptContext(org.eclipse.birt.report.engine.api.script.IReportContext context)
Deprecated. implement #init(IReportItemGenerationInfo) instead |
Method Detail |
---|
void init(IReportItemGenerationInfo info)
void setModelObject(org.eclipse.birt.report.model.api.ExtendedItemHandle modelHandle)
modelHandle
- a handle to the extended item model objectvoid setApplicationClassLoader(java.lang.ClassLoader loader)
loader
- class loader used to load the classesvoid setScriptContext(org.eclipse.birt.report.engine.api.script.IReportContext context)
context
- report context used by java-based scriptvoid setReportQueries(org.eclipse.birt.data.engine.api.IDataQueryDefinition[] queries)
void onRowSets(IRowSet[] rowSets) throws org.eclipse.birt.core.exception.BirtException
rowSets
- rowSets an array of row sets that is passed to the extension
org.eclipse.birt.core.exception.BirtException
- throws exception when there is a problem processing the
extended itemvoid onRowSets(IBaseResultSet[] results) throws org.eclipse.birt.core.exception.BirtException
results
- results is an array of query results which is passed to the
extended item. The extended item could retrieve data from
those results.
org.eclipse.birt.core.exception.BirtException
- throws exception when there is a problem processing the
extended itemboolean needSerialization()
void serialize(java.io.OutputStream ostream) throws org.eclipse.birt.core.exception.BirtException
ostream
- the output stream to write the generation time state of the
extended item to
org.eclipse.birt.core.exception.BirtException
- when there is a problem serializing the extended item stateorg.eclipse.birt.report.engine.extension.Size getSize()
void finish()
void setExtendedItemContent(IContent content)
content
- content which is transformed from extended item.IReportItemGenerationInfo getGenerationConfig()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |