Package com.infragistics.reveal.sdk.api.model

Class RVDataSourceItem

java.lang.Object

com.infragistics.reveal.sdk.api.model.RVDataSourceItem

Direct Known Subclasses:

RVAnalysisServicesDataSourceItem, RVAthenaDataSourceItem, RVBaseSharePointDataSourceItem, RVBigQueryDataSourceItem, RVBoxDataSourceItem, RVDropboxDataSourceItem, RVDynamicsCrmDataSourceItem, RVGoogleAnalytics4DataSourceItem, RVGoogleAnalyticsDataSourceItem, RVGoogleDriveDataSourceItem, RVGoogleSearchConsoleDataSourceItem, RVHubspotDataSourceItem, RVInMemoryDataSourceItem, RVLocalFileDataSourceItem, RVMarketoDataSourceItem, 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 Summary

Constructors

Constructor	Description
RVDataSourceItem(RVDashboardDataSource dataSource)

Method Summary

Modifier and Type	Method	Description
RVDashboardDataSource	getDataSource()	Reference to the data source object this item belongs to.
Number	getDefaultRefreshRate()	Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g.
String	getDescription()	Description of this data source item.
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.
String	getSubtitle()	The subtitle of the data source as displayed to users.
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.
protected RVDashboardDataSource	setDataSource(RVDashboardDataSource value)	Reference to the data source object this item belongs to.
void	setDefaultRefreshRate(Number v)	Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g.
String	setDescription(String value)	Description of this data source item.
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.
void	setSubtitle(String sub)	The subtitle of the data source as displayed to users.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RVDataSourceItem

public RVDataSourceItem(RVDashboardDataSource dataSource)

Method Detail

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 -