Package io.revealbi.core.data

Class RVExcelDataSourceItem

java.lang.Object
io.revealbi.core.data.RVDataSourceItem
io.revealbi.core.data.RVResourceBasedDataSourceItem
io.revealbi.core.data.RVExcelDataSourceItem
Direct Known Subclasses:
RVGoogleSheetDataSourceItem
public class RVExcelDataSourceItem extends RVResourceBasedDataSourceItem
The data source item used to represent a dataset from an Excel file, it includes information like the name of the sheet to get data from and the range to use when loading data.

  • Constructor Details

    • RVExcelDataSourceItem

      public RVExcelDataSourceItem(IRVResourceItem resourceItem)

  • Method Details

    • setSheet

      public String setSheet(String value)
      Name of the sheet in the worksheet to get the data from, if not specified and getNamedRange() is null, then the first sheet in the file will be used.
      Parameters:
      value -
      Returns:

    • getSheet

      public String getSheet()
      Name of the sheet in the worksheet to get the data from, if not specified and getNamedRange() is null, then the first sheet in the file will be used.
      Returns:

    • setRange

      public RVExcelRange setRange(RVExcelRange value)
      Definition of the range to load data from in the specified sheet.
      Parameters:
      value -
      Returns:

    • getRange

      public RVExcelRange getRange()
      Definition of the range to load data from in the specified sheet.
      Returns:

    • setNamedRange

      public String setNamedRange(String value)
      Named range to get data from, it's optional and if no specified the sheet specified in getSheet() will be used.
      Parameters:
      value -
      Returns:

    • getNamedRange

      public String getNamedRange()
      Named range to get data from, it's optional and if no specified the sheet specified in getSheet() will be used.
      Returns:

    • setPivotTable

      public String setPivotTable(String value)
      Sets the name of the pivot table to get data from within the Excel file.
      Parameters:
      value - The pivot table name.
      Returns:
      The value that was set.

    • getPivotTable

      public String getPivotTable()
      Returns the name of the pivot table to get data from within the Excel file.
      Returns:
      The pivot table name, or null if not set.

    • setFirstRowContainsLabels

      public boolean setFirstRowContainsLabels(boolean value)
      If you set this flag to false the columns will be automatically named as 'COL1', 'COL2', etc.
      Parameters:
      value -
      Returns:

    • getFirstRowContainsLabels

      public boolean getFirstRowContainsLabels()
      If you set this flag to false the columns will be automatically named as 'COL1', 'COL2', etc.
      Returns: