|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
an engine task that extracts data from a report. The task allows the return of metadata and data from engine User first creates the task from engine, then sets a report component ID, or report component instance ID. If none is set, data extraction is assumed to be based on all the data stored in the report. The user can call the getMetaData method to retrieve metadata for each resultset. Based on the metadata, he can select additional columns, add filter conditions, or specify sorting conditions.
Field Summary |
Fields inherited from interface org.eclipse.birt.report.engine.api.IEngineTask |
CANCEL_ON_ERROR, CONTINUE_ON_ERROR, STATUS_CANCELLED, STATUS_FAILED, STATUS_NOT_STARTED, STATUS_RUNNING, STATUS_SUCCEEDED, TASK_DATAEXTRACTION, TASK_GETPARAMETERDEFINITION, TASK_RENDER, TASK_RUN, TASK_RUNANDRENDER, TASK_UNKNOWN |
Method Summary | |
IExtractionResults |
extract()
|
java.util.List |
getMetaData()
Deprecated. |
java.util.List |
getResultSetList()
returns the metadata corresponding to the data stored in the report document, for the specific extraction level, i.e., report, daat set, report item, or report item instance levels. |
void |
selectColumns(java.lang.String[] columnNames)
|
void |
selectResultSet(java.lang.String resultSetName)
select the result set from which to export data. |
void |
setFilters(IFilterDefinition[] simpleFilterExpression)
|
void |
setInstanceID(InstanceID iid)
* @param iid identifies a report item instance that data extraction will happen on |
Methods inherited from interface org.eclipse.birt.report.engine.api.IEngineTask |
addScriptableJavaObject, cancel, cancel, close, getAppContext, getCancelFlag, getEngine, getErrors, getID, getLocale, getLogger, getParameterDisplayText, getParameterValue, getParameterValues, getReportRunnable, getStatus, getTaskType, getULocale, setAppContext, setDataSource, setErrorHandlingOption, setLocale, setLocale, setLogger, setParameter, setParameterDisplayText, setParameterValue, setParameterValues, validateParameters |
Method Detail |
public void setInstanceID(InstanceID iid)
public java.util.List getMetaData() throws EngineException
EngineException
public java.util.List getResultSetList() throws EngineException
EngineException
public void selectResultSet(java.lang.String resultSetName)
resultSetName
- the result set namepublic void selectColumns(java.lang.String[] columnNames)
public void setFilters(IFilterDefinition[] simpleFilterExpression)
simpleFilterExpression
- add one filter condition to the extraction. Only simple filter
expressions are supported for now, i.e., LHS must be a column
name, only <, >, = and startWith is supported.public IExtractionResults extract() throws EngineException
EngineException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |