Package io.revealbi.core.data

Class RVDataSourceItem

java.lang.Object
io.revealbi.core.data.RVDataSourceItem
Direct Known Subclasses:
RVAnalysisServicesDataSourceItem, RVAthenaDataSourceItem, RVAzureCosmosDBDataSourceItem, RVBaseSharePointDataSourceItem, RVBigQueryDataSourceItem, RVBoxDataSourceItem, RVDropboxDataSourceItem, RVDynamicsCrmDataSourceItem, RVElasticsearchDataSourceItem, RVGoogleAnalytics4DataSourceItem, RVGoogleDriveDataSourceItem, RVGoogleSearchConsoleDataSourceItem, RVHubspotDataSourceItem, RVInMemoryDataSourceItem, RVLocalFileDataSourceItem, RVMarketoDataSourceItem, RVMongoDBDataSourceItem, RVODataDataSourceItem, RVOneDriveDataSourceItem, RVQuickBooksDataSourceItem, RVReportingServicesDataSourceItem, RVResourceBasedDataSourceItem, RVRESTDataSourceItem, RVS3DataSourceItem, RVSqlBasedDataSourceItem, RVWebResourceDataSourceItem
public abstract class RVDataSourceItem extends Object
The basic class for data source items that can be used by visualizations to get data. When getting data from a database for example, the data source object contains the information required to connect to the database (like server host and database name) and the data source item contains the information required to get the dataset itself (like table name or view name).

  • Constructor Details

  • Method Details

    • setTitle

      public String setTitle(String value)
      The title of the item, as displayed to the user, it might be for example the name of the table in a database.
      Parameters:
      value -
      Returns:

    • getTitle

      public String getTitle()
      The title of the item, as displayed to the user, it might be for example the name of the table in a database.
      Returns:

    • setId

      public String setId(String value)
      The value that identifies this item in the data source, it might be for example the name of the schema concatenated with the table name.
      Parameters:
      value -
      Returns:

    • getId

      public String getId()
      The value that identifies this item in the data source, it might be for example the name of the schema concatenated with the table name.
      Returns:

    • setDescription

      public String setDescription(String value)
      Description of this data source item.
      Parameters:
      value -
      Returns:

    • getDescription

      public String getDescription()
      Description of this data source item.
      Returns:

    • setDataSource

      protected RVDashboardDataSource setDataSource(RVDashboardDataSource value)
      Reference to the data source object this item belongs to.
      Parameters:
      value -
      Returns:

    • getDataSource

      public RVDashboardDataSource getDataSource()
      Reference to the data source object this item belongs to.
      Returns:

    • getSubtitle

      public String getSubtitle()
      The subtitle of the data source as displayed to users.
      Returns:

    • setSubtitle

      public void setSubtitle(String sub)
      The subtitle of the data source as displayed to users.
      Parameters:
      sub -

    • getDefaultRefreshRate

      public Number getDefaultRefreshRate()
      Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. If not set it will use the default value set in the data source object.
      Returns:

    • setDefaultRefreshRate

      public void setDefaultRefreshRate(Number v)
      Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. If not set it will use the default value set in the data source object.
      Parameters:
      v -