Interface IDataExtractionTask

All Superinterfaces:
IEngineTask, IExtractionTask

public interface IDataExtractionTask extends IExtractionTask
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.
  • Method Details

    • setCubeExportEnabled

      void setCubeExportEnabled(boolean isCubeExportEnabled)
      to set the indicator whether to enable the cube export functionality.
    • isCubeExportEnabled

      boolean isCubeExportEnabled()
      to indicate whether the cube export functionality should be enabled or not.
    • setInstanceID

      void setInstanceID(InstanceID iid)
      * @param iid identifies a report item instance that data extraction will happen on
    • getMetaData

      @Deprecated List getMetaData() throws EngineException
      Deprecated.
      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. To get the metadata for the extracted data, use the getResultMetaData method from the IDataIterator interface.
      Returns:
      a List of IResultMetaData. The list usually has one result set meta data, but could have more if data extraction is based on the whole report
      Throws:
      EngineException
    • getResultSetList

      List getResultSetList() throws EngineException
      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. To get the metadata for the extracted data, use the getResultMetaData method from the IDataIterator interface.
      Returns:
      a List of IResultSetItem.
      Throws:
      EngineException
    • selectResultSet

      void selectResultSet(String resultSetName)
      select the result set from which to export data.
      Parameters:
      resultSetName - the result set name
    • selectColumns

      void selectColumns(String[] columnNames)
      Parameters:
      columnName - name of the column to be included in the data set
    • setMaxRows

      void setMaxRows(int maxRows)
      Parameters:
      maxRows - set the maximum rows that are returned from ResultSet
    • setStartRow

      void setStartRow(int startRow)
      Sets start row of the result.
    • setDistinctValuesOnly

      void setDistinctValuesOnly(boolean distinct)
      whether gets distinct values
    • extract

      Redeclare this method in order to return IExtractionResults.
      Specified by:
      extract in interface IExtractionTask
      Returns:
      the extraction result
      Throws:
      EngineException