|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDataExtractionTask
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()
|
void |
extract(IDataExtractionOption option)
|
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 |
setDistinctValuesOnly(boolean distinct)
whether gets distinct values |
void |
setFilters(org.eclipse.birt.data.engine.api.IFilterDefinition[] simpleFilterExpression)
|
void |
setInstanceID(InstanceID iid)
* @param iid identifies a report item instance that data extraction will happen on |
void |
setMaxRows(int maxRows)
|
void |
setSorts(org.eclipse.birt.data.engine.api.ISortDefinition[] simpleSortExpression)
|
void |
setStartRow(int startRow)
Sets start row of the result. |
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, setDataSource, setErrorHandlingOption, setLocale, setLocale, setLogger, setParameter, setParameterDisplayText, setParameterValue, setParameterValues, setTimeZone, setUserACL, validateParameters |
Method Detail |
---|
void setInstanceID(InstanceID iid)
java.util.List getMetaData() throws EngineException
EngineException
java.util.List getResultSetList() throws EngineException
EngineException
void selectResultSet(java.lang.String resultSetName)
resultSetName
- the result set namevoid selectColumns(java.lang.String[] columnNames)
columnName
- name of the column to be included in the data setvoid setFilters(org.eclipse.birt.data.engine.api.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.void setSorts(org.eclipse.birt.data.engine.api.ISortDefinition[] simpleSortExpression)
simpleSortExpression
- add one sort condition to the extractionvoid setMaxRows(int maxRows)
maxRows
- set the maximum rows that are returned from ResultSetvoid setStartRow(int startRow)
void setDistinctValuesOnly(boolean distinct)
IExtractionResults extract() throws EngineException
EngineException
void extract(IDataExtractionOption option) throws org.eclipse.birt.core.exception.BirtException
org.eclipse.birt.core.exception.BirtException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |