Index

A B C D E F G I L M N O P Q R S T V W Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addHeader(String, String) - Method in class io.revealbi.core.data.RVHeadersDataSourceCredentials
Adds a new header to this credentials object.
addHeader(String, String) - Method in interface io.revealbi.core.impl.IHttpResponse
 
addPlugin(RevealPlugin) - Method in class io.revealbi.core.RevealServerBuilder
 
addPlugin(RevealPlugin) - Method in class io.revealbi.core.RevealSettings
 
addRedisCache(Consumer<RVRedisOptions>) - Method in class io.revealbi.core.RevealServerBuilder
Configures Redis as the cache provider for the Reveal server.
addSettings(Consumer<RevealSettings>) - Method in class io.revealbi.core.RevealServerBuilder
Applies additional settings to the Reveal server configuration.
ALL - Enum constant in enum class io.revealbi.core.RVPeriodRelation
All time
ALL_TIME - Enum constant in enum class io.revealbi.core.RVDateFilterType
No filter defined, all time is included
Auto - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 
Avg - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 

B

build() - Method in class io.revealbi.core.RevealServerBuilder
Builds the Reveal server.

C

CACHE_ENCRYPTION_ENABLED - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key to enable or disable encryption of cache files.
CACHE_ENCRYPTION_PASSWORD - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the password used to encrypt cache files when encryption is enabled.
CACHE_PATH - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the file system path where the Reveal engine stores its cache files.
changeDataSource(IRVUserContext, RVDashboardDataSource) - Method in interface io.revealbi.core.data.IRVDataSourceProvider
This method can be used to replace a data source, returning null indicates Reveal to use the original data source.
changeDataSourceItem(IRVUserContext, String, RVDataSourceItem) - Method in interface io.revealbi.core.data.IRVDataSourceProvider
This method can be used to replace a data source, returning null indicates Reveal to use the original data source.
CountDistinct - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 
CountNonEmpty - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 
CountRows - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 
CredentialSerializer - Class in io.revealbi.core.impl.serializers
 
CredentialSerializer() - Constructor for class io.revealbi.core.impl.serializers.CredentialSerializer
 
Csv - Enum constant in enum class io.revealbi.core.ExportFormat
 
CsvExportOptions - Class in io.revealbi.core
Contains CSV configuration for exporting a dashboard.
CsvExportOptions() - Constructor for class io.revealbi.core.CsvExportOptions
Creates a new CsvExportOptions instance with formatted values enabled by default.
CsvExportOptions(IExportOptions) - Constructor for class io.revealbi.core.CsvExportOptions
Creates a new CsvExportOptions by copying settings from an existing IExportOptions instance.
CUSTOM_RANGE - Enum constant in enum class io.revealbi.core.RVDateFilterType
Custom range, an instance of RVDateRange must be set in the range property.
CUSTOM_RULE - Enum constant in enum class io.revealbi.core.RVDateFilterType
New implementation for date rules

D

DashboardDataSourceSerializer - Class in io.revealbi.core.impl.serializers
Serializes and deserializes RVDashboardDataSource objects to/from JSON strings.
DashboardDataSourceSerializer() - Constructor for class io.revealbi.core.impl.serializers.DashboardDataSourceSerializer
 
DATA - Enum constant in enum class io.revealbi.core.data.RVReportingServicesRenderMode
Export the report as raw data (exported to CSV).
DataModelSerializer - Class in io.revealbi.core.impl.serializers
Serializer/deserializer for data model types used by IRVDataModelProvider.
DataModelSerializer() - Constructor for class io.revealbi.core.impl.serializers.DataModelSerializer
 
DataModelSerializer.EditSchemaRequest - Class in io.revealbi.core.impl.serializers
Holds the deserialized components of an edit-schema callback request.
dataSourceItem - Variable in class io.revealbi.core.impl.serializers.DataModelSerializer.EditSchemaRequest
 
DataSourceItemSerializer - Class in io.revealbi.core.impl.serializers
Central registry and serializer for all data source item types.
DataSourceItemSerializer(DashboardDataSourceSerializer) - Constructor for class io.revealbi.core.impl.serializers.DataSourceItemSerializer
 
Date - Enum constant in enum class io.revealbi.core.data.RVDashboardDataType
Date data
DATE - Enum constant in enum class io.revealbi.core.data.RVSchemaColumnType
 
DATE_TIME - Enum constant in enum class io.revealbi.core.data.RVSchemaColumnType
 
DateTime - Enum constant in enum class io.revealbi.core.data.RVDashboardDataType
Date data including time
DAY - Enum constant in enum class io.revealbi.core.RVPeriodType
Day
DefaultDashboardExporter - Class in io.revealbi.core.impl.exporter
 
DefaultDashboardExporter(IRevealServer) - Constructor for class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
DefaultDashboardTheme - Class in io.revealbi.core
Represents the default dashboard theme colors used for exports.
DefaultDashboardTheme() - Constructor for class io.revealbi.core.DefaultDashboardTheme
Initializes a new instance of the default dashboard theme.
DefaultDashboardTheme(IDashboardTheme) - Constructor for class io.revealbi.core.DefaultDashboardTheme
Initializes a new instance of the default dashboard theme from an existing theme.
deserialize(JsonNode) - Method in class io.revealbi.core.impl.serializers.DataSourceItemSerializer
Deserializes a data source item from an already-parsed JsonNode, avoiding a string round-trip when the node was extracted from a larger JSON document.
deserialize(String) - Method in class io.revealbi.core.impl.serializers.DashboardDataSourceSerializer
 
deserialize(String) - Method in class io.revealbi.core.impl.serializers.DataSourceItemSerializer
Deserializes a data source item from its JSON string representation.
deserializeEditSchemaRequest(String, DataSourceItemSerializer) - Method in class io.revealbi.core.impl.serializers.DataModelSerializer
Deserializes the full body of a /data-model-edit-schema request into an DataModelSerializer.EditSchemaRequest, parsing the JSON exactly once and extracting both the dataSourceItem and schema fields without intermediate string round-trips.
deserializeFields(JsonNode) - Method in class io.revealbi.core.impl.serializers.DataModelSerializer
Deserializes a list of RVDataModelField from an already-parsed JsonNode.
deserializeFields(String) - Method in class io.revealbi.core.impl.serializers.DataModelSerializer
Deserializes a list of RVDataModelField from a JSON string.
deserializeList(String) - Method in class io.revealbi.core.impl.serializers.DataSourceItemSerializer
 
destroy() - Method in class io.revealbi.servlet.RevealEngineServlet
 
DIRECT - Enum constant in enum class io.revealbi.core.data.RVAzureCosmosDBConnectionMode
Uses direct TCP connections to CosmosDB replicas.
DO_NOT_INCLUDE - Enum constant in enum class io.revealbi.core.ExcelVisualizationMode
 
DocumentExportOptions - Class in io.revealbi.core
Contains document configuration for exporting a dashboard.
DocumentExportOptions() - Constructor for class io.revealbi.core.DocumentExportOptions
Initializes a new instance of the document export options.
DocumentExportOptions(IExportOptions) - Constructor for class io.revealbi.core.DocumentExportOptions
Initializes a new instance of the document export options from existing export options.
DoNotInclude - Enum constant in enum class io.revealbi.core.ExportExcelVisualization
 

E

editSchema(RVDataSourceItem, List<RVDataModelField>, IRequestContext) - Method in interface io.revealbi.core.data.IRVDataModelProvider
Called to allow editing the schema fields of the given data source item.
Excel - Enum constant in enum class io.revealbi.core.ExportFormat
 
ExcelExportOptions - Class in io.revealbi.core
Contains Excel configuration for exporting a dashboard.
ExcelExportOptions() - Constructor for class io.revealbi.core.ExcelExportOptions
Creates a new ExcelExportOptions instance with ExcelVisualizationMode.INCLUDE as the default mode.
excelVisualization - Variable in class io.revealbi.core.ExcelExportOptions
Deprecated.
Deprecated: Please use VisualizationMode instead.
ExcelVisualizationMode - Enum Class in io.revealbi.core
Specifies how visualizations are included in Excel exports.
export(ExportFormat, String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to a specific format
export(ExportFormat, String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
export(ExportFormat, String, IRVUserContext, IExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to a specific format
export(ExportFormat, String, IRVUserContext, IExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
export(ExportFormat, String, String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to a specific format
export(ExportFormat, String, String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
export(ExportFormat, String, String, IRVUserContext, IExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to a specific format
export(ExportFormat, String, String, IRVUserContext, IExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
ExportConfiguration - Class in io.revealbi.core
Contains configuration settings for dashboard exports.
ExportConfiguration() - Constructor for class io.revealbi.core.ExportConfiguration
 
ExportExcelVisualization - Enum Class in io.revealbi.core
Specifies whether visualizations are included in Excel exports.
ExportException - Exception Class in io.revealbi.core
Represents an exception thrown during export operations.
ExportException(String, Throwable) - Constructor for exception class io.revealbi.core.ExportException
Initializes a new instance of the export exception.
ExportFormat - Enum Class in io.revealbi.core
Specifies the available export formats.
ExportOptions - Class in io.revealbi.core
Contains base configuration for exporting a dashboard.
ExportOptions() - Constructor for class io.revealbi.core.ExportOptions
Initializes a new instance of the export options.
ExportOptions(IExportOptions) - Constructor for class io.revealbi.core.ExportOptions
Initializes a new instance of the export options from existing export options.
exportToCsv(String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to CSV.
exportToCsv(String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToCsv(String, IRVUserContext, CsvExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to CSV.
exportToCsv(String, IRVUserContext, CsvExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToCsv(String, String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to CSV.
exportToCsv(String, String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToCsv(String, String, IRVUserContext, CsvExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to CSV.
exportToCsv(String, String, IRVUserContext, CsvExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToExcel(String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Excel.
exportToExcel(String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToExcel(String, IRVUserContext, ExcelExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Excel.
exportToExcel(String, IRVUserContext, ExcelExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToExcel(String, String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Excel.
exportToExcel(String, String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToExcel(String, String, IRVUserContext, ExcelExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Excel.
exportToExcel(String, String, IRVUserContext, ExcelExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToImage(String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Image (png).
exportToImage(String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToImage(String, IRVUserContext, ImageExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Image (png).
exportToImage(String, IRVUserContext, ImageExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToImage(String, String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Image (png).
exportToImage(String, String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToImage(String, String, IRVUserContext, ImageExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Image (png).
exportToImage(String, String, IRVUserContext, ImageExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToPdf(String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Pdf.
exportToPdf(String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToPdf(String, IRVUserContext, PdfExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Pdf.
exportToPdf(String, IRVUserContext, PdfExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToPdf(String, String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Pdf.
exportToPdf(String, String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToPdf(String, String, IRVUserContext, PdfExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to Pdf.
exportToPdf(String, String, IRVUserContext, PdfExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToPowerPoint(String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to PowerPoint.
exportToPowerPoint(String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToPowerPoint(String, IRVUserContext, PowerPointExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to PowerPoint.
exportToPowerPoint(String, IRVUserContext, PowerPointExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToPowerPoint(String, String) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to PowerPoint.
exportToPowerPoint(String, String) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 
exportToPowerPoint(String, String, IRVUserContext, PowerPointExportOptions) - Method in interface io.revealbi.core.IDashboardExporter
Exports a dashboard to PowerPoint.
exportToPowerPoint(String, String, IRVUserContext, PowerPointExportOptions) - Method in class io.revealbi.core.impl.exporter.DefaultDashboardExporter
 

F

filter(IRVUserContext, RVDataSourceItem) - Method in interface io.revealbi.core.data.IRVObjectFilter
Used to filter DataSourceItems to be returned to the client.
FORM - Enum constant in enum class io.revealbi.core.data.RVSharePointAuthenticationMethod
 

G

GATEWAY - Enum constant in enum class io.revealbi.core.data.RVAzureCosmosDBConnectionMode
Uses HTTPS connections through the CosmosDB gateway.
getAcceptAnyServerCertificate() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
When set to true, the HTTP client accepts any server certificate without validation.
getAccount() - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the account used to connect to Snowflake
getAccountEndpoint() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets or sets the URI of the Azure CosmosDB account endpoint (e.g.
getAccountId() - Method in class io.revealbi.core.data.RVGoogleAnalytics4DataSourceItem
Account identifier to get data from.
getAdvancedSetting(String) - Method in class io.revealbi.core.RevealSettings
Returns the value of the specified advanced setting.
getAdvancedSettings() - Method in class io.revealbi.core.RevealSettings
Returns all advanced settings.
getApplicationRegion() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets or sets the preferred Azure region for read and write operations.
getAssemblyPath() - Method in class io.revealbi.core.RevealPlugin
 
getAssetContentType() - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Content-type of the item.
getAsyncTimeoutMs() - Method in class io.revealbi.core.RVRedisOptions
Gets the asynchronous operation timeout in milliseconds.
getAuthenticationMethod() - Method in class io.revealbi.core.data.RVSharePointDataSource
The authentication method to use when connecting to Sharepoint.
getAuthor() - Method in class io.revealbi.core.DocumentExportOptions
Document author.
getAuthor() - Method in interface io.revealbi.core.IDocumentExportOptions
Document author.
getAWSAccountId() - Method in class io.revealbi.core.data.RVS3DataSource
Only for internal use.
getBody() - Method in class io.revealbi.core.data.RVRESTDataSource
Body to send, expected to be used only with POST and PUT methods.
getBrandGreenColor() - Method in class io.revealbi.core.DefaultDashboardTheme
 
getBrandGreenColor() - Method in interface io.revealbi.core.IDashboardTheme
Returns the brand green color.
getBrandingColor() - Method in class io.revealbi.core.DefaultDashboardTheme
 
getBrandingColor() - Method in interface io.revealbi.core.IDashboardTheme
Returns the branding color used for theming exported dashboards.
getBrandRedColor() - Method in class io.revealbi.core.DefaultDashboardTheme
 
getBrandRedColor() - Method in interface io.revealbi.core.IDashboardTheme
Returns the brand red color.
getCacheEncryptionPassword() - Method in class io.revealbi.core.RevealSettings
Sets the encryption password for the SQLite cache files (ignored if encryption is disabled)
getCachePath() - Method in class io.revealbi.core.RevealSettings
Directory where cache-related files (e.g., downloaded artifacts) are stored.
getCalculatedFields(RVDataSourceItem, IRequestContext) - Method in interface io.revealbi.core.data.IRVDataModelProvider
Called to retrieve additional calculated fields for the given data source item.
getCallbacks() - Method in class io.revealbi.core.RevealPlugin
 
getCatalog() - Method in class io.revealbi.core.data.RVAnalysisServicesDataSource
The name of the catalog (database) to use.
getCatalog() - Method in class io.revealbi.core.data.RVAnalysisServicesDataSourceItem
The name of the catalog (database) containing the cube.
getCertificateFingerprint() - Method in class io.revealbi.core.data.RVElasticsearchDataSource
(Optional) Gets or sets the hex-encoded SHA-256 fingerprint of the Elasticsearch CA certificate used to establish trust for SSL/TLS connections.
getChromiumDownloadFolder() - Method in class io.revealbi.core.ExportConfiguration
Indicates the folder where Chromium will be downloaded.
getChromiumExecutablePath() - Method in class io.revealbi.core.ExportConfiguration
Path to Chromium executable file.
getClassName() - Method in class io.revealbi.core.RevealPlugin
 
getClientId() - Method in class io.revealbi.core.data.RVMicrosoftEntraIDDataSourceCredential
Returns the application (client) ID registered in Azure AD.
getClientId() - Method in class io.revealbi.core.data.RVOAuthDataSourceCredential
Returns the OAuth client ID.
getClientName() - Method in class io.revealbi.core.RVRedisOptions
Gets the client name used to identify this connection in Redis.
getClientSecret() - Method in class io.revealbi.core.data.RVMicrosoftEntraIDDataSourceCredential
Returns the client secret for the registered application.
getClientSecret() - Method in class io.revealbi.core.data.RVOAuthDataSourceCredential
Returns the OAuth client secret.
getCollection() - Method in class io.revealbi.core.data.RVMongoDBDataSourceItem
Gets or sets the name of the collection.
getColor() - Method in class io.revealbi.core.DocumentExportOptions
Color used for titles underlines
getColor() - Method in interface io.revealbi.core.IDocumentExportOptions
Color used for titles underlines
getCompany() - Method in class io.revealbi.core.DocumentExportOptions
Company name displayed in the lower left corner
getCompany() - Method in interface io.revealbi.core.IDocumentExportOptions
Company name displayed in the lower left corner
getConfig() - Method in class io.revealbi.core.data.RVJsonDataSourceItem
The configuration of the JSON parser.
getConnectionMode() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets or sets the connection mode used to communicate with the CosmosDB service.
getConnectionString() - Method in class io.revealbi.core.data.RVMongoDBDataSource
Connection string for connecting to the MongoDB host.
getConnectionString() - Method in class io.revealbi.core.RVRedisOptions
Gets the Redis server connection string (e.g., "localhost:6379").
getConnectRetry() - Method in class io.revealbi.core.RVRedisOptions
Gets the number of connection retry attempts.
getConnectTimeoutMs() - Method in class io.revealbi.core.RVRedisOptions
Gets the connection timeout in milliseconds.
getContainer() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSourceItem
Gets or sets the name of the container.
getContentLength() - Method in interface io.revealbi.core.impl.IHttpRequest
 
getContentType() - Method in class io.revealbi.core.data.RVRESTDataSource
Content type of the body, only used when RVRESTDataSource.getBody() is not empty.
getCount() - Method in class io.revealbi.core.RVDateRule
Amount of periods to be counted.
getCreateChromiumInstancesOnDemand() - Method in class io.revealbi.core.ExportConfiguration
Indicates if Chromium instances are created when they are needed, or when application is started.
getCreatedBy() - Method in class io.revealbi.core.DocumentExportOptions
Deprecated.
getCreatedBy() - Method in class io.revealbi.core.ExcelExportOptions
Deprecated.
Deprecated: This property is no longer used in excel exports and will be removed in future versions.
getCube() - Method in class io.revealbi.core.data.RVAnalysisServicesDataSourceItem
Name of the cube to use
getCustomQuery() - Method in class io.revealbi.core.data.RVAthenaDataSourceItem
(Optional) Custom SQL query to use when getting data.
getCustomQuery() - Method in class io.revealbi.core.data.RVBigQueryDataSourceItem
(Optional) Custom SQL query to use when getting data.
getCustomQuery() - Method in class io.revealbi.core.data.RVDynamicsCrmDataSourceItem
Custom query to use when getting data from Dynamics CRM.
getCustomQuery() - Method in class io.revealbi.core.data.RVElasticsearchDataSourceItem
(Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.
getCustomQuery() - Method in class io.revealbi.core.data.RVMongoDBDataSourceItem
(Optional) Custom MongoDB query to use when getting data
getCustomQuery() - Method in class io.revealbi.core.data.RVSqlBasedDataSourceItem
(Optional) Custom SQL query to use when getting data.
getDashboard(IRVUserContext, String) - Method in interface io.revealbi.core.IRVDashboardProvider
Loads the dashboard with the given dashboardId for the given user.
getDashboard(IRVUserContext, String) - Method in class io.revealbi.core.RVDashboardProvider
Load dashboard from provided in the constructor location on the file system.
getDashboardExporter() - Method in class io.revealbi.core.impl.RevealServer
 
getDashboardExporter() - Method in interface io.revealbi.core.IRevealServer
Returns the dashboard exporter.
getData() - Method in interface io.revealbi.core.data.IRVInMemoryData
Returns an Iterable object with all rows in this dataset, please note data is returned as an Iterable, so there's no need to have all data loaded in memory.
getData(IRVUserContext, RVInMemoryDataSourceItem) - Method in interface io.revealbi.core.data.IRVDataProvider
Returns the in-memory data for this data source, you can use the RVInMemoryDataSourceItem.getDatasetId() property to know what dataset to return.
getDatabase() - Method in class io.revealbi.core.data.RVAthenaDataSource
Athena's database to use.
getDatabase() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets or sets the name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSourceItem
Gets or sets the name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVClickHouseDataSource
Name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVDatabricksDataSource
Gets the name of the database/catalog to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVMongoDBDataSource
Gets or sets the name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVMySqlDataSource
Name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVOracleDataSource
Name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVPostgresDataSource
Name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVRedshiftDataSource
Name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVSqlBasedDataSourceItem
Name of the database to connect to, optional as this value is usually specified in the data source object.
getDatabase() - Method in class io.revealbi.core.data.RVSqlServerDataSource
Name of the database to connect to.
getDatabase() - Method in class io.revealbi.core.data.RVSyBaseDataSource
Name of the database to connect to.
getDataCatalog() - Method in class io.revealbi.core.data.RVAthenaDataSource
Athena's data catalog where the database is.
getDatasetId() - Method in class io.revealbi.core.data.RVBigQueryDataSourceItem
BigQuery dataset.
getDatasetId() - Method in class io.revealbi.core.data.RVInMemoryDataSourceItem
String identifying this in-memory dataset, it might be used to decide what data to return.
getDataSource() - Method in class io.revealbi.core.data.RVDataSourceItem
Reference to the data source object this item belongs to.
getDateFilterType() - Method in class io.revealbi.core.RVDateDashboardFilter
Deprecated.
getDateFormat() - Method in class io.revealbi.core.data.RVCsvDataSourceItem
Optional date format to use when parsing/detecting date columns, if not specified Reveal will try to infer the date format to use for each column (if it detects the column is a date, date time or time column).
getDefaultAggregation() - Method in class io.revealbi.core.data.RVDataModelField
Returns the default aggregation type for this field.
getDefaultDatabase() - Method in class io.revealbi.core.RVRedisOptions
Gets the default Redis database number to use.
getDefaultRefreshRate() - Method in class io.revealbi.core.data.RVDashboardDataSource
Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g.
getDefaultRefreshRate() - Method in class io.revealbi.core.data.RVDataSourceItem
Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g.
getDescription() - Method in class io.revealbi.core.data.RVDataModelField
Returns the description of the field.
getDescription() - Method in class io.revealbi.core.data.RVDataModelMeasure
Returns the description of the measure.
getDescription() - Method in class io.revealbi.core.data.RVDataSourceItem
Description of this data source item.
getDomain() - Method in class io.revealbi.core.data.RVUsernamePasswordDataSourceCredential
Returns the domain (used for Windows/NTLM authentication).
getDynamic() - Method in class io.revealbi.core.data.RVReportingServicesDataSourceItem
Returns the dynamic report path used to override the static path at runtime.
getEffectiveUserName() - Method in class io.revealbi.core.data.RVNativeAnalysisServicesDataSource
Optional user name to impersonate, in 'DOMAIN/username' format.
getEncoding() - Method in class io.revealbi.core.data.RVCsvDataSourceItem
The encoding to use, if not specified Reveal will try to detect it automatically.
getEncrypt() - Method in class io.revealbi.core.data.RVSqlServerDataSource
If not null, the Encrypt flag will be set in the connection string to the specified value.
getEndDate() - Method in class io.revealbi.core.data.RVHubspotDataSourceItem
End date to use when requesting data.
getEndDate() - Method in class io.revealbi.core.data.RVMarketoDataSourceItem
End date to use when requesting data.
getEndPoints() - Method in class io.revealbi.core.RVRedisOptions
Gets the list of endpoint URLs for connecting to Redis.
getEntity() - Method in class io.revealbi.core.data.RVDynamicsCrmDataSourceItem
Name of the entity to use.
getEntity() - Method in class io.revealbi.core.data.RVHubspotDataSourceItem
Entity to retrieve data from.
getEntity() - Method in class io.revealbi.core.data.RVMarketoDataSourceItem
Entity to retrieve data from.
getEntity() - Method in class io.revealbi.core.data.RVQuickBooksDataSourceItem
QuickBooks Entity.
getEntityType() - Method in class io.revealbi.core.data.RVODataDataSourceItem
Returns the OData entity type name used to map the response to a known schema.
getExcelVisualization() - Method in class io.revealbi.core.ExcelExportOptions
Deprecated.
Deprecated: Please use VisualizationMode instead.
getExportConfiguration() - Method in class io.revealbi.core.RevealSettings
Returns the export configuration.
getExportingTimeout() - Method in class io.revealbi.core.ExportConfiguration
Indicates the time in ms to wait when exporting dashboard is called.
getExpression() - Method in class io.revealbi.core.data.RVDataModelCalculatedField
Returns the expression that defines this calculated field.
getExpression() - Method in class io.revealbi.core.data.RVDataModelMeasure
Returns the expression that defines this measure.
getFieldMultiValueLeniency() - Method in class io.revealbi.core.data.RVElasticsearchDataSource
(Optional) Gets or sets the flag to control the behavior when SQL queries encounter fields with multiple values.
getFieldMultiValueLeniency() - Method in class io.revealbi.core.data.RVElasticsearchDataSourceItem
(Optional) Controls behavior when SQL queries encounter fields with multiple values.
getFilters() - Method in class io.revealbi.core.ExportOptions
Dashboard filters applied during the export.
getFilters() - Method in interface io.revealbi.core.IExportOptions
Dashboard filters applied during the export.
getFirstRowContainsLabels() - Method in class io.revealbi.core.data.RVExcelDataSourceItem
If you set this flag to false the columns will be automatically named as 'COL1', 'COL2', etc.
getFolderRelativePath() - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Path relative to the folder containing the item.
getFrom() - Method in class io.revealbi.core.RVDateRange
The beginning of the range.
getFunctionName() - Method in class io.revealbi.core.data.RVPostgresDataSourceItem
(Optional) name of the function to get data from, the function is expected to return a result set and might have multiple parameters.
getFunctionName() - Method in class io.revealbi.core.data.RVRedshiftDataSourceItem
(Optional) name of the function to get data from, the function is expected to return a result set and might have multiple parameters.
getFunctionParameters() - Method in class io.revealbi.core.data.RVPostgresDataSourceItem
Parameters to be passed to the function, if there is such specified in RVPostgresDataSourceItem.getFunctionName().
getFunctionParameters() - Method in class io.revealbi.core.data.RVRedshiftDataSourceItem
Parameters to be passed to the function, if there is such specified in RVRedshiftDataSourceItem.getFunctionName().
getFunctionQName() - Method in class io.revealbi.core.data.RVODataDataSourceItem
Returns the qualified name of the OData function or action to invoke.
getHeaderNames() - Method in interface io.revealbi.core.impl.IHttpRequest
 
getHeaders() - Method in class io.revealbi.core.data.RVHeadersDataSourceCredentials
Returns the HTTP headers that will be included in data requests.
getHeaders() - Method in class io.revealbi.core.data.RVRESTDataSource
List of headers to send in the request, each string in this list is expected to be a string in the format name=value.
getHeaders(String) - Method in interface io.revealbi.core.impl.IHttpRequest
 
getHost() - Method in class io.revealbi.core.data.RVNativeAnalysisServicesDataSource
Hostname or IP address of the server
getHost() - Method in class io.revealbi.core.data.RVSqlBasedDataSource
Host name or IP address to connect to.
getHttpPath() - Method in class io.revealbi.core.data.RVDatabricksDataSource
Gets the partial URL corresponding to the server to connect to.
getId() - Method in class io.revealbi.core.data.RVDashboardDataSource
The ID of the data source.
getId() - Method in class io.revealbi.core.data.RVDataSourceItem
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.
getId() - Method in interface io.revealbi.core.IRVDashboardFilter
Returns the filter ID.
getId() - Method in class io.revealbi.core.RVDashboardFilter
The ID of the filter.
getId() - Method in class io.revealbi.core.RVDateDashboardFilter
The ID of the filter.
getId() - Method in class io.revealbi.core.VisualizationExport
Visualization's id
getIdentifier() - Method in class io.revealbi.core.data.RVBoxDataSourceItem
Identifier of the file referenced by this item.
getIdentifier() - Method in class io.revealbi.core.data.RVGoogleDriveDataSourceItem
Google Drive identifier of the file referenced by this item.
getIdentifier() - Method in class io.revealbi.core.data.RVOneDriveDataSourceItem
Identifier of the file in OneDrive.
getIncludeFiltersSummaryPage() - Method in class io.revealbi.core.ExportOptions
Indicates whether a summary page listing the active filters is appended to the export.
getIncludeFiltersSummaryPage() - Method in interface io.revealbi.core.IExportOptions
Indicates whether a summary page listing the active filters is appended to the export.
getIndex() - Method in class io.revealbi.core.data.RVElasticsearchDataSourceItem
The name of the Elasticsearch index to query.
getInitScript() - Method in class io.revealbi.core.DocumentExportOptions
Indicates a script used to initialize revealView when exporting.
getInitScript() - Method in interface io.revealbi.core.IInitScriptProviderExportOptions
Indicates a script used to initialize revealView when exporting.
getInitScript() - Method in class io.revealbi.core.ImageExportOptions
Indicates a script used to initialize revealView when exporting.
getInputStream() - Method in interface io.revealbi.core.impl.IHttpRequest
 
getIsFolder() - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Is this single item a folder?.
getIsLandscape() - Method in class io.revealbi.core.DocumentExportOptions
Indicates page orientation when exporting
getIsLandscape() - Method in interface io.revealbi.core.IDocumentExportOptions
Indicates page orientation when exporting
getIsLibrary() - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
Is this list a document library?
getKeepAliveSeconds() - Method in class io.revealbi.core.RVRedisOptions
Gets the keep-alive interval in seconds.
getKey() - Method in class io.revealbi.core.data.RVAmazonWebServicesCredentials
Returns the AWS access key ID.
getLabel() - Method in class io.revealbi.core.data.RVDataModelField
Returns the label of the field (display name).
getLabel() - Method in class io.revealbi.core.data.RVSchemaColumn
Returns the display label for the column shown in Reveal.
getLengthX() - Method in class io.revealbi.core.data.RVExcelRange
Returns the number of columns in the range.
getLengthY() - Method in class io.revealbi.core.data.RVExcelRange
Returns the number of rows in the range.
getLicense() - Method in class io.revealbi.core.RevealSettings
getListItemId() - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Identification of the single item in the list.
getListItemUrl() - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
URL to the single item.
getListName() - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
The title of the list (not the GUID!).
getListName() - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Name of the list.
getListUrl() - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
URL to the list.
getLocalFilesStoragePath() - Method in class io.revealbi.core.RevealSettings
getLocationX() - Method in class io.revealbi.core.data.RVExcelRange
Returns the zero-based column index of the top-left cell of the range.
getLocationY() - Method in class io.revealbi.core.data.RVExcelRange
Returns the zero-based row index of the top-left cell of the range.
getLogo() - Method in class io.revealbi.core.DocumentExportOptions
Company logo displayed in the lower left corner.
getLogo() - Method in interface io.revealbi.core.IDocumentExportOptions
Company logo displayed in the lower left corner.
getMappingRelativePath() - Method in interface io.revealbi.core.impl.IHttpRequest
 
getMaxCacheAge() - Method in class io.revealbi.core.ExportOptions
Maximum age of cached data used during the export.
getMaxCacheAge() - Method in interface io.revealbi.core.IExportOptions
Maximum age of cached data used during the export.
getMaxCells() - Method in class io.revealbi.core.ExportOptions
Max cells returned when getting dashboard data
getMaxCells() - Method in interface io.revealbi.core.IExportOptions
Max cells returned when getting dashboard data
getMaxConcurrentExportingThreads() - Method in class io.revealbi.core.ExportConfiguration
Max allowed concurrent Threads for the exporting to image tool (Playwright).
getMaxDownloadSize() - Method in class io.revealbi.core.RevealSettings
getMaxFilterSize() - Method in class io.revealbi.core.RevealSettings
Maximum number of elements allowed for filters.
getMaxInMemoryCells() - Method in class io.revealbi.core.RevealSettings
Expected maximum size of pivot tables or grids, as a number of in-memory cells.
getMaxStorageCells() - Method in class io.revealbi.core.RevealSettings
Expected maximum number of cells to be processed from any data source (e.g., SQL Server rows, CSV rows).
getMaxStringCellSize() - Method in class io.revealbi.core.RevealSettings
Limit on the number of characters any single string cell may have in a dataset column.
getMaxTotalStringsSize() - Method in class io.revealbi.core.RevealSettings
Expected maximum size of pivot tables or grids given as the total number of characters across all cells in a dataset.
getMeasures(RVDataSourceItem, IRequestContext) - Method in interface io.revealbi.core.data.IRVDataModelProvider
Called to retrieve additional measures for the given data source item.
getMethod() - Method in class io.revealbi.core.data.RVRESTDataSource
HTTP method to use, it defaults to GET.
getMethod() - Method in interface io.revealbi.core.impl.IHttpRequest
 
getName() - Method in class io.revealbi.core.data.RVDataModelField
Returns the name of the field.
getName() - Method in class io.revealbi.core.data.RVDataModelMeasure
Returns the name of the measure.
getName() - Method in class io.revealbi.core.data.RVSchemaColumn
Returns the desired field name.
getName() - Method in class io.revealbi.core.RevealPlugin
 
getNamedRange() - Method in class io.revealbi.core.data.RVExcelDataSourceItem
Named range to get data from, it's optional and if no specified the sheet specified in RVExcelDataSourceItem.getSheet() will be used.
getNeutralColor() - Method in class io.revealbi.core.DefaultDashboardTheme
 
getNeutralColor() - Method in interface io.revealbi.core.IDashboardTheme
Returns the neutral color.
getNodes() - Method in class io.revealbi.core.data.RVElasticsearchDataSource
Gets or sets the list of Elasticsearch node endpoints to connect to in the cluster.
getOrganization() - Method in class io.revealbi.core.data.RVDynamicsCrmDataSourceItem
Name of the organization to use.
getOutputLocation() - Method in class io.revealbi.core.data.RVAthenaDataSource
s3 path where the results will be stored.
getOutputStream() - Method in interface io.revealbi.core.impl.IHttpResponse
 
getParameters() - Method in class io.revealbi.core.data.RVInMemoryDataSourceItem
Parameters for the in-memory data source.
getParameters() - Method in class io.revealbi.core.data.RVReportingServicesDataSourceItem
Returns the report parameters passed to the Reporting Services report.
getParameters() - Method in class io.revealbi.core.data.RVRESTDataSourceItem
Values for the parameters specified in the data source RVRESTDataSource.getUrl() property.
getParameters() - Method in class io.revealbi.core.RevealPlugin
 
getPassword() - Method in class io.revealbi.core.data.RVUsernamePasswordDataSourceCredential
Returns the password.
getPassword() - Method in class io.revealbi.core.RVRedisOptions
Gets the password for Redis authentication.
getPath() - Method in class io.revealbi.core.data.RVClickHouseDataSource
(Optional) The URL path appended after the host and port.
getPath() - Method in class io.revealbi.core.data.RVDropboxDataSourceItem
Path to the file in Dropbox account.
getPath() - Method in class io.revealbi.core.data.RVReportingServicesDataSource
Path in the server, used only when SSRS is running integrated into SharePoint
getPath() - Method in class io.revealbi.core.data.RVReportingServicesDataSourceItem
Path to the report.
getPath() - Method in class io.revealbi.core.data.RVS3DataSourceItem
S3 path for the file represented by this item.
getPeriodRelation() - Method in class io.revealbi.core.RVDateRule
Relation of the rule's time period to the current date.
getPeriodType() - Method in class io.revealbi.core.RVDateRule
Type of time period used as time unit for the rule's period.
getPivotTable() - Method in class io.revealbi.core.data.RVExcelDataSourceItem
Returns the name of the pivot table to get data from within the Excel file.
getPlugins() - Method in class io.revealbi.core.RevealSettings
 
getPort() - Method in class io.revealbi.core.data.RVNativeAnalysisServicesDataSource
TCP port where the server is accepting connections, 2383 is the default port for SSAS.
getPort() - Method in class io.revealbi.core.data.RVSqlBasedDataSource
TCP Port to connect to.
getPoweredBy() - Method in class io.revealbi.core.DocumentExportOptions
Deprecated.
getPoweredBy() - Method in class io.revealbi.core.ExcelExportOptions
Deprecated.
Deprecated: This property is no longer used in excel exports and will be removed in future versions.
getPrivateKey() - Method in class io.revealbi.core.data.RVKeyPairDataSourceCredential
Returns the private key used for authentication.
getProcedure() - Method in class io.revealbi.core.data.RVMySqlDataSourceItem
(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.
getProcedure() - Method in class io.revealbi.core.data.RVSnowflakeDataSourceItem
(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.
getProcedure() - Method in class io.revealbi.core.data.RVSqlServerDataSourceItem
(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.
getProcedureParameters() - Method in class io.revealbi.core.data.RVMySqlDataSourceItem
Parameters to be passed to the stored procedure, if there is such specified in RVMySqlDataSourceItem.getProcedure().
getProcedureParameters() - Method in class io.revealbi.core.data.RVSnowflakeDataSourceItem
Parameters to be passed to the stored procedure, if there is such specified in RVSnowflakeDataSourceItem.getProcedure().
getProcedureParameters() - Method in class io.revealbi.core.data.RVSqlServerDataSourceItem
Parameters to be passed to the stored procedure, if there is such specified in RVSqlServerDataSourceItem.getProcedure().
getProcessDataOnServer() - Method in interface io.revealbi.core.data.IProcessDataOnServerDataSourceItem
Configures if the "Process Data on Server" option is turned on for this item (table or view).
getProcessDataOnServer() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSourceItem
Returns whether data processing is performed on the Reveal server.
getProcessDataOnServer() - Method in class io.revealbi.core.data.RVElasticsearchDataSourceItem
Returns whether data processing is performed on the Reveal server.
getProcessDataOnServer() - Method in class io.revealbi.core.data.RVMongoDBDataSourceItem
Returns whether data processing is performed on the Reveal server.
getProcessDataOnServer() - Method in class io.revealbi.core.data.RVSqlPDSDataSourceItem
Configures if the "Process Data on Server" option is turned on for this item (table or view), defaults to true.
getProcessDataOnServerDefaultValue() - Method in interface io.revealbi.core.data.IProcessDataOnServerDataSource
Gets the default value for "Process Data on Server" option for this data source.
getProcessDataOnServerDefaultValue() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets the default value for "Process Data on Server" option for this data source.
getProcessDataOnServerDefaultValue() - Method in class io.revealbi.core.data.RVElasticsearchDataSource
Gets the default value for "Process Data on Server" option for this data source.
getProcessDataOnServerDefaultValue() - Method in class io.revealbi.core.data.RVMongoDBDataSource
Gets the default value for "Process Data on Server" option for this data source.
getProcessDataOnServerDefaultValue() - Method in class io.revealbi.core.data.RVSqlPDSDataSource
Sets the default value for "Process Data on Server" option for this data source, the end user can still change the value, unless RVSqlPDSDataSource.setProcessDataOnServerReadOnly(boolean) is true.
getProcessDataOnServerReadOnly() - Method in interface io.revealbi.core.data.IProcessDataOnServerDataSource
Gets whether the user is allowed to change the value for "Process Data on Server" option.
getProcessDataOnServerReadOnly() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
When true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
getProcessDataOnServerReadOnly() - Method in class io.revealbi.core.data.RVElasticsearchDataSource
When true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
getProcessDataOnServerReadOnly() - Method in class io.revealbi.core.data.RVMongoDBDataSource
When true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
getProcessDataOnServerReadOnly() - Method in class io.revealbi.core.data.RVSqlPDSDataSource
When set to true the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
getProjectId() - Method in class io.revealbi.core.data.RVBigQueryDataSource
BigQuery ProjectId.
getProjectId() - Method in class io.revealbi.core.data.RVBigQueryDataSourceItem
BigQuery ProjectId.
getProperties() - Method in class io.revealbi.core.ExportConfiguration
 
getProperties() - Method in interface io.revealbi.core.IRequestContext
Returns the properties attached to this request context.
getProperties() - Method in class io.revealbi.core.RVUserContext
Returns the map of additional properties associated with this user context.
getProperty(String) - Method in class io.revealbi.core.RVUserContext
Returns the value for the given property or null if no property with that name is found.
getPropertyId() - Method in class io.revealbi.core.data.RVGoogleAnalytics4DataSourceItem
Property identifier to get data from.
getProtocol() - Method in class io.revealbi.core.data.RVClickHouseDataSource
(Optional) The protocol used to connect to ClickHouse (e.g.
getProviderKey() - Method in class io.revealbi.core.data.RVAnalysisServicesDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVAthenaDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVAzureAnalysisServicesDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVAzureSqlDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVAzureSynapseDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVBigQueryDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVBoxDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVClickHouseDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVCsvDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVDashboardDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVDatabricksDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVDropboxDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVDynamicsCrmDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVElasticsearchDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVExcelDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVGoogleAnalytics4DataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVGoogleDriveDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVGoogleSearchConsoleDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVGoogleSheetDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVHubspotDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVInMemoryDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVJsonDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVLocalFileDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVMarketoDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVMongoDBDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVMySqlDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVODataDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVOneDriveDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVOracleDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVPostgresDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVQuickBooksDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVRedshiftDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVReportingServicesDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVRESTDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVS3DataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVSharePointDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVSnowflakeDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVSqlServerDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVSyBaseDataSource
 
getProviderKey() - Method in class io.revealbi.core.data.RVWebResourceDataSource
 
getQueryString() - Method in interface io.revealbi.core.impl.IHttpRequest
 
getRange() - Method in class io.revealbi.core.data.RVExcelDataSourceItem
Definition of the range to load data from in the specified sheet.
getRange() - Method in class io.revealbi.core.RVDateDashboardFilter
The date range used for filtering.
getRealmId() - Method in class io.revealbi.core.data.RVQuickBooksDataSource
Realm Id, the unique ID identifying a specific QuickBooks company.
getReconnectRetryPolicy() - Method in class io.revealbi.core.RVRedisOptions
Gets the reconnection retry policy: "Linear" or "Exponential".
getRedisOptions() - Method in class io.revealbi.core.RevealSettings
Gets the Redis cache options.
getRegion() - Method in class io.revealbi.core.data.RVAthenaDataSource
Region for the service.
getRegion() - Method in class io.revealbi.core.data.RVS3DataSource
Region for the service.
getRenderMode() - Method in class io.revealbi.core.data.RVReportingServicesDataSourceItem
Render mode, might be data or report.
getResourceItem() - Method in class io.revealbi.core.data.RVResourceBasedDataSourceItem
The resource item used to get the data for the referenced file, must be an item from one of the resource providers: Sharepoint, Web Resource, REST API, etc.
getRetryDelayMs() - Method in class io.revealbi.core.RVRedisOptions
Gets the base delay in milliseconds used by the retry policy.
getRevealServer() - Method in class io.revealbi.servlet.RevealEngineServlet
 
getRole() - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the role that will be used to access Snowflake.
getRule() - Method in class io.revealbi.core.RVDateDashboardFilter
The date rule used for filtering.
getSchema() - Method in interface io.revealbi.core.data.IRVInMemoryData
Returns the schema for this dataset, basically the list of columns (name and data type), data returned by IRVInMemoryData.getData() must be returned in the same order than the columns defined by this method.
getSchema() - Method in class io.revealbi.core.data.RVDatabricksDataSource
Gets the name of the schema to connect to.
getSchema() - Method in class io.revealbi.core.data.RVDatabricksDataSourceItem
Gets the name of the schema to connect to.
getSchema() - Method in class io.revealbi.core.data.RVPostgresDataSource
Name of the schema to use.
getSchema() - Method in class io.revealbi.core.data.RVPostgresDataSourceItem
Name of the schema the referenced table belongs to.
getSchema() - Method in class io.revealbi.core.data.RVRedshiftDataSource
Name of the schema to use.
getSchema() - Method in class io.revealbi.core.data.RVRedshiftDataSourceItem
Name of the schema the referenced table belongs to.
getSchema() - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the schema the referenced table belongs to.
getSchema() - Method in class io.revealbi.core.data.RVSnowflakeDataSourceItem
Name of the schema the referenced table belongs to.
getSchema() - Method in class io.revealbi.core.data.RVSqlServerDataSource
Name of the schema to use to filter tables, views and store procedures, by default all schemas are displayed.
getSchema() - Method in class io.revealbi.core.data.RVSqlServerDataSourceItem
Name of the schema the referenced table belongs to.
getSchema() - Method in class io.revealbi.core.data.RVSyBaseDataSourceItem
Name of the schema the referenced table belongs to.
getSdkJsDistributionFile() - Method in class io.revealbi.core.ExportConfiguration
Indicates a local zip file containing the sdk js distribution.
getSecret() - Method in class io.revealbi.core.data.RVAmazonWebServicesCredentials
Returns the AWS secret access key.
getSeparator() - Method in class io.revealbi.core.data.RVCsvDataSourceItem
The separator to use, one of ',', ';', or 'TAB'.
getSerializationFriendlyName() - Method in enum class io.revealbi.core.ExcelVisualizationMode
Returns the serialization-friendly name for this visualization mode.
getSerializationFriendlyName() - Method in enum class io.revealbi.core.RVDateFilterType
Returns the serialization-friendly name of this filter type (used for JSON serialization).
getSerializationFriendlyName() - Method in enum class io.revealbi.core.RVPeriodRelation
 
getSerializationFriendlyName() - Method in enum class io.revealbi.core.RVPeriodType
 
getSeriesColor() - Method in class io.revealbi.core.DefaultDashboardTheme
 
getSeriesColor() - Method in interface io.revealbi.core.IDashboardTheme
Returns the series colors.
getServerMode() - Method in class io.revealbi.core.data.RVReportingServicesDataSource
Returns the server mode for Reporting Services.
getServerUrl() - Method in class io.revealbi.core.data.RVAzureAnalysisServicesDataSource
Server Url, including the 'asazure://' prefix (scheme).
getServerVersion() - Method in class io.revealbi.core.data.RVReportingServicesDataSource
Returns the Reporting Services server version.
getService() - Method in class io.revealbi.core.data.RVOracleServiceDataSource
Service name to use when connecting to Oracle server.
getSessionToken() - Method in class io.revealbi.core.data.RVAmazonWebServicesCredentials
Returns the session token for temporary AWS credentials.
getSheet() - Method in class io.revealbi.core.data.RVExcelDataSourceItem
Name of the sheet in the worksheet to get the data from, if not specified and RVExcelDataSourceItem.getNamedRange() is null, then the first sheet in the file will be used.
getShowTitle() - Method in class io.revealbi.core.VisualizationExport
Indicates whether the visualization title will be displayed on the captured image.
getSID() - Method in class io.revealbi.core.data.RVOracleSIDDataSource
SID to use when connecting to Oracle server.
getSiteUrl() - Method in class io.revealbi.core.data.RVGoogleSearchConsoleDataSourceItem
The URL of the property as defined in Search Console
getSkipServerCertificateValidation() - Method in class io.revealbi.core.data.RVClickHouseDataSource
(Optional) When true, skips server certificate validation for TLS connections.
getStartDate() - Method in class io.revealbi.core.data.RVHubspotDataSourceItem
Start date to use when requesting data.
getStartDate() - Method in class io.revealbi.core.data.RVMarketoDataSourceItem
Start date to use when requesting data.
getSubtitle() - Method in class io.revealbi.core.data.RVDashboardDataSource
The subtitle of the data source as displayed to users.
getSubtitle() - Method in class io.revealbi.core.data.RVDataSourceItem
The subtitle of the data source as displayed to users.
getSyncTimeoutMs() - Method in class io.revealbi.core.RVRedisOptions
Gets the synchronous operation timeout in milliseconds.
getTable() - Method in class io.revealbi.core.data.RVAthenaDataSourceItem
Table or view for this data source item.
getTable() - Method in class io.revealbi.core.data.RVBigQueryDataSourceItem
Name of the table (or view) to get data from.
getTable() - Method in class io.revealbi.core.data.RVSqlBasedDataSourceItem
Name of the table (or view) to get data from.
getTenantId() - Method in class io.revealbi.core.data.RVMicrosoftEntraIDDataSourceCredential
Returns the Azure AD tenant (directory) ID.
getTheme() - Method in class io.revealbi.core.ExportOptions
Theme object to indicate export used colors
getTheme() - Method in interface io.revealbi.core.IExportOptions
Theme object to indicate export used colors
getTimeout() - Method in class io.revealbi.core.data.RVClickHouseDataSource
(Optional) Connection timeout in seconds.
getTimeout() - Method in class io.revealbi.core.ExportOptions
Timeout in seconds for exporting a dashboard
getTimeout() - Method in interface io.revealbi.core.IExportOptions
Timeout in seconds for exporting a dashboard
getTimeZone() - Method in class io.revealbi.core.ExportOptions
Timezone in IANA format
getTimeZone() - Method in interface io.revealbi.core.IExportOptions
Timezone in IANA format
getTitle() - Method in class io.revealbi.core.data.RVDashboardDataSource
The title of the data source as displayed to users.
getTitle() - Method in class io.revealbi.core.data.RVDataSourceItem
The title of the item, as displayed to the user, it might be for example the name of the table in a database.
getTitle() - Method in interface io.revealbi.core.IRVDashboardFilter
Returns the filter title.
getTitle() - Method in class io.revealbi.core.RVDashboardFilter
The title of the filter.
getTitle() - Method in class io.revealbi.core.RVDateDashboardFilter
The title of the filter.
getTitle() - Method in class io.revealbi.core.VisualizationExport
Visualization's title
getTo() - Method in class io.revealbi.core.RVDateRange
The end of the range
getToken() - Method in class io.revealbi.core.data.RVBearerTokenDataSourceCredential
Returns the bearer token used for authentication.
getToken() - Method in class io.revealbi.core.data.RVPersonalAccessTokenDataSourceCredential
Returns the personal access token.
getTrustServerCertificate() - Method in class io.revealbi.core.data.RVSqlServerDataSource
If not null, the TrustServerCertificate flag will be set in the connection string to the specified value.
getType() - Method in class io.revealbi.core.data.RVDataModelField
Returns the data type of the field.
getType() - Method in class io.revealbi.core.data.RVSchemaColumn
Returns the desired data type.
getUri() - Method in class io.revealbi.core.data.RVLocalFileDataSourceItem
The URI referencing the file, like local://Directory/File.csv.
getUrl() - Method in class io.revealbi.core.data.RVDynamicsCrmDataSource
Dynamics CRM base URL.
getUrl() - Method in class io.revealbi.core.data.RVHttpAnalysisServicesDataSource
URL to the msmdpump endpoint, for example: http://server/olap/msmdpump.dll
getUrl() - Method in class io.revealbi.core.data.RVMarketoDataSource
URL to the login endpoint.
getUrl() - Method in class io.revealbi.core.data.RVMarketoDataSourceItem
URL to the Marketo endpoint, must match the URL specified in the RVMarketoDataSource data source object.
getUrl() - Method in class io.revealbi.core.data.RVODataDataSource
URL to the OData endpoint, is expected to be a URL with HTTP or HTTPS scheme.
getUrl() - Method in class io.revealbi.core.data.RVODataDataSourceItem
URL to the OData entity set or function.
getUrl() - Method in class io.revealbi.core.data.RVReportingServicesDataSource
URL to the server
getUrl() - Method in class io.revealbi.core.data.RVRESTDataSource
URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme.
getUrl() - Method in class io.revealbi.core.data.RVRESTDataSourceItem
Deprecated.
This method is deprecated and will be removed in a future release. Use RVRESTDataSource.getUrl() instead.
getUrl() - Method in class io.revealbi.core.data.RVSharePointDataSource
URL to the Sharepoint site (or sub site) to use.
getUrl() - Method in class io.revealbi.core.data.RVWebResourceDataSource
URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme.
getUrl() - Method in class io.revealbi.core.data.RVWebResourceDataSourceItem
URL to use to download the file, must match the URL specified in the RVWebResourceDataSource data source object.
getUseAnonymousAuthentication() - Method in class io.revealbi.core.data.RVODataDataSource
Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.
getUseAnonymousAuthentication() - Method in class io.revealbi.core.data.RVRESTDataSource
Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.
getUseAnonymousAuthentication() - Method in class io.revealbi.core.data.RVWebResourceDataSource
Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.
getUseFormattedValues() - Method in class io.revealbi.core.CsvExportOptions
Indicates whether to use formatted values for CSV export.
getUseFormattedValues() - Method in interface io.revealbi.core.ICsvExportOptions
Returns whether formatted values are used instead of raw data values.
getUseNewCharts() - Method in class io.revealbi.core.ExportOptions
 
getUseNewCharts() - Method in interface io.revealbi.core.IExportOptions
 
getUsePreemptiveAuthentication() - Method in class io.revealbi.core.data.RVODataDataSource
Boolean flag indicating if preemptive authentication should be used for this data source to the containing application.
getUsePreemptiveAuthentication() - Method in class io.revealbi.core.data.RVRESTDataSource
Boolean flag indicating if preemptive authentication should be used for this data source to the containing application.
getUser() - Method in class io.revealbi.core.RVRedisOptions
Gets the username for Redis authentication.
getUserContext() - Method in interface io.revealbi.core.IRVSystemUserContextProvider
Returns the user context to be used for system-level callbacks.
getUserContext(HttpServletRequest) - Method in interface io.revealbi.servlet.IRVServletUserContextProvider
 
getUserId() - Method in class io.revealbi.core.data.RVBearerTokenDataSourceCredential
Returns the user ID associated with this credential.
getUserId() - Method in class io.revealbi.core.data.RVSharePointPeopleDataSourceItem
Optional user id when a single user should be displayed.
getUserId() - Method in interface io.revealbi.core.IRequestContext
Returns the ID of the user associated with this request.
getUserId() - Method in class io.revealbi.core.RVUserContext
Returns the userId for this context.
getUserLanguage() - Method in class io.revealbi.core.ExportOptions
User language
getUserLanguage() - Method in interface io.revealbi.core.IExportOptions
User language
getUserName() - Method in class io.revealbi.core.data.RVKeyPairDataSourceCredential
Returns the user name for key-pair authentication.
getUserName() - Method in class io.revealbi.core.data.RVUsernamePasswordDataSourceCredential
Returns the user name.
getValue() - Method in enum class io.revealbi.core.data.RVAzureCosmosDBConnectionMode
Returns the integer value of this connection mode constant.
getValue() - Method in enum class io.revealbi.core.data.RVGoogleAnalyticsResourceType
Returns the integer value of this enum constant.
getValue() - Method in enum class io.revealbi.core.data.RVReportingServicesRenderMode
Returns the integer value of this render mode constant.
getValue() - Method in enum class io.revealbi.core.data.RVSchemaColumnType
Returns the integer value of this column type constant.
getValue() - Method in enum class io.revealbi.core.data.RVSharePointAuthenticationMethod
Returns the integer value of this authentication method constant.
getValue() - Method in enum class io.revealbi.core.data.RVSharePointItemType
Returns the integer value of this item type constant.
getValue() - Method in enum class io.revealbi.core.RVDateFilterType
The internal value associated to this filter type.
getValues() - Method in class io.revealbi.core.RVDashboardFilter
Returns the filter values.
getView() - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
Name of the view to use.
getVisualizationMode() - Method in class io.revealbi.core.ExcelExportOptions
 
getVisualizationMode() - Method in interface io.revealbi.core.IExcelExportOptions
Indicates additional configuration for Excel, see ExcelVisualizationMode
getVisualizations() - Method in class io.revealbi.core.ExportOptions
List of visualizations that will be exported.
getVisualizations() - Method in interface io.revealbi.core.IExportOptions
List of visualizations that will be exported.
getWarehouse() - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the Snowflake warehouse to use in this connection
getWebUrl() - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
URL to the site containing the list.
getWebUrl() - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
URL to the site containing the list.
getWebUrl() - Method in class io.revealbi.core.data.RVSharePointSiteDataSourceItem
URL to the site or sub site.
getWorkgroup() - Method in class io.revealbi.core.data.RVAthenaDataSource
Workgroup used to run queries.

I

ICsvExportOptions - Interface in io.revealbi.core
Defines CSV-specific export options.
IDashboardExporter - Interface in io.revealbi.core
Interface exposing methods to export dashboards to different formats.
IDashboardTheme - Interface in io.revealbi.core
Defines dashboard theme colors used for exports.
IDocumentExportOptions - Interface in io.revealbi.core
Defines document-specific export options.
IExcelExportOptions - Interface in io.revealbi.core
Defines additional configuration for Excel export.
IExportOptions - Interface in io.revealbi.core
Indicates configuration for exporting a dashboard
IHttpRequest - Interface in io.revealbi.core.impl
 
IHttpResponse - Interface in io.revealbi.core.impl
 
IInitScriptProviderExportOptions - Interface in io.revealbi.core
Defines export options that provide an initialization script.
Image - Enum constant in enum class io.revealbi.core.ExportFormat
 
ImageExportOptions - Class in io.revealbi.core
Contains Image configuration for exporting a dashboard.
ImageExportOptions() - Constructor for class io.revealbi.core.ImageExportOptions
Creates a new ImageExportOptions instance with default settings.
ImageExportOptions(IExportOptions) - Constructor for class io.revealbi.core.ImageExportOptions
Creates a new ImageExportOptions by copying settings from an existing IExportOptions instance.
Include - Enum constant in enum class io.revealbi.core.ExportExcelVisualization
 
INCLUDE - Enum constant in enum class io.revealbi.core.ExcelVisualizationMode
 
INCLUDE_ON_DIFFERENT_SHEET - Enum constant in enum class io.revealbi.core.ExcelVisualizationMode
 
IncludeOnDifferentSheet - Enum constant in enum class io.revealbi.core.ExportExcelVisualization
 
init() - Method in class io.revealbi.servlet.RevealEngineServlet
 
invoke(IRVUserContext, String) - Method in interface io.revealbi.core.RevealPluginCallback
 
io.revealbi.core - package io.revealbi.core
Main Reveal API Package containing the interfaces to be implemented in order to control how Reveal BI works.
io.revealbi.core.data - package io.revealbi.core.data
 
io.revealbi.core.impl - package io.revealbi.core.impl
 
io.revealbi.core.impl.exporter - package io.revealbi.core.impl.exporter
 
io.revealbi.core.impl.serializers - package io.revealbi.core.impl.serializers
 
io.revealbi.servlet - package io.revealbi.servlet
 
IProcessDataOnServerDataSource - Interface in io.revealbi.core.data
Interface for data sources that support the "Process Data on Server" option, allowing queries to be executed on the server instead of fetching all data to the client.
IProcessDataOnServerDataSourceItem - Interface in io.revealbi.core.data
Interface for data source items that support server-side data processing.
IRequestContext - Interface in io.revealbi.core
Provides context about the request being processed, including the user's identity and any additional properties attached to the request.
IRevealServer - Interface in io.revealbi.core
Defines the Reveal server contract.
IRVAuthenticationProvider - Interface in io.revealbi.core.data
The interface that must be implemented and provided to the Reveal server.
IRVDashboardFilter - Interface in io.revealbi.core
Defines a dashboard filter.
IRVDashboardProvider - Interface in io.revealbi.core
The interface that provides loading and saving of dashboards, it must be implemented and passed to Reveal Engine initialization.
IRVDataModelProvider - Interface in io.revealbi.core.data
Beta interface for customizing the data model exposed by a data source.
IRVDataProvider - Interface in io.revealbi.core.data
The interface that must be implemented to return in-memory data for dashboards.
IRVDataSourceCredential - Interface in io.revealbi.core.data
Base interface representing credentials to connect to a given data source
IRVDataSourceProvider - Interface in io.revealbi.core.data
The interface that must be implemented to replace data sources.
IRVInMemoryData - Interface in io.revealbi.core.data
The interface representing in-memory data to be returned by IRVDataProvider, please note data is returned as an Iterable, so there's no need to have all data loaded in memory.
IRVObjectFilter - Interface in io.revealbi.core.data
Allows filtering of 'objects' (DataSourceItems) to be returned to the client.
IRVResourceItem - Interface in io.revealbi.core.data
Interface representing items used to get a file (resource) from one of the resource providers (Sharepoint, Web Resource, etc.).
IRVServletUserContextProvider - Interface in io.revealbi.servlet
 
IRVSystemUserContextProvider - Interface in io.revealbi.core
Provides the IRVUserContext for system-level engine callbacks that are not associated with a normal client request.
IRVUserContext - Interface in io.revealbi.core
An interface used to identify the user, related to a particular call to the methods of IRVDashboardProvider, IRVAuthenticationProvider, IRVDataProvider and other providers.
isAbortOnConnectFail() - Method in class io.revealbi.core.RVRedisOptions
Returns whether the connection should abort immediately on a connection failure.
isAllowAdmin() - Method in class io.revealbi.core.RVRedisOptions
Returns whether admin commands (e.g., FLUSHDB, CONFIG) are allowed.
isCacheEncryptionEnabled() - Method in class io.revealbi.core.RevealSettings
Enables the use of encryption of the SQLite cache (only works for the newer SQLite cache).
isLegacyCacheEnabled() - Method in class io.revealbi.core.RevealSettings
Uses the legacy SQLite cache.
isUseSsl() - Method in class io.revealbi.core.RVRedisOptions
Returns whether SSL/TLS encryption is enabled.
isWeekLevelEnabled() - Method in class io.revealbi.core.data.RVDataModelField
Returns whether week-level grouping is enabled for date fields.

L

LAST - Enum constant in enum class io.revealbi.core.RVPeriodRelation
Last [period] = 1 [period] ago until today
LAST_MONTH - Enum constant in enum class io.revealbi.core.RVDateFilterType
Last 30 days
LAST_WEEK - Enum constant in enum class io.revealbi.core.RVDateFilterType
Last 7 days
LAST_YEAR - Enum constant in enum class io.revealbi.core.RVDateFilterType
Last 365 days
LEGACY_CACHE_ENABLED - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key to enable or disable the legacy cache implementation.
LIST - Enum constant in enum class io.revealbi.core.data.RVSharePointItemType
 
LIST_ITEM - Enum constant in enum class io.revealbi.core.data.RVSharePointItemType
 
LOCAL_FILE_ROOT_DIR_PROPERTY - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the local file system root directory used by the local files data source.
LOG_DIR - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the directory where Reveal engine log files are written.
LOG_LEVEL - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the logging verbosity level of the Reveal engine.

M

Max - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 
MAX_DOWNLOAD_SIZE - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the maximum download size (in bytes) allowed when fetching remote data.
MAX_FILTER_SIZE - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the maximum number of elements returned in a dashboard filter list.
MAX_IN_MEMORY_CELLS - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the maximum number of cells held in memory during data processing.
MAX_STORAGE_CELLS - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the maximum number of cells written to storage during data processing.
MAX_STRING_CELL_SIZE - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the maximum size (in bytes) of a single string cell value.
MAX_TOTAL_STRINGS_SIZE - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the maximum total size (in bytes) of string data retained in memory.
Min - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 
MONTH - Enum constant in enum class io.revealbi.core.RVPeriodType
Month
MONTH_TO_DATE - Enum constant in enum class io.revealbi.core.RVDateFilterType
From the first day of the current month

N

NEXT - Enum constant in enum class io.revealbi.core.RVPeriodRelation
Next [period] = beginning of next [period] until end of next [period]
NEXT_MONTH - Enum constant in enum class io.revealbi.core.RVDateFilterType
The next month
NEXT_QUARTER - Enum constant in enum class io.revealbi.core.RVDateFilterType
The next quarter
NEXT_YEAR - Enum constant in enum class io.revealbi.core.RVDateFilterType
The next year
Number - Enum constant in enum class io.revealbi.core.data.RVDashboardDataType
Numeric data, including integer and floating-point values
NUMBER - Enum constant in enum class io.revealbi.core.data.RVSchemaColumnType
 

O

OFFICE365 - Enum constant in enum class io.revealbi.core.data.RVSharePointAuthenticationMethod
 

P

Pdf - Enum constant in enum class io.revealbi.core.ExportFormat
 
PdfExportOptions - Class in io.revealbi.core
Contains Pdf configuration for exporting a dashboard.
PdfExportOptions() - Constructor for class io.revealbi.core.PdfExportOptions
Creates a new PdfExportOptions instance with default settings.
PdfExportOptions(IExportOptions) - Constructor for class io.revealbi.core.PdfExportOptions
Creates a new PdfExportOptions by copying settings from an existing IExportOptions instance.
PEOPLE - Enum constant in enum class io.revealbi.core.data.RVSharePointItemType
 
PowerPoint - Enum constant in enum class io.revealbi.core.ExportFormat
 
PowerPointExportOptions - Class in io.revealbi.core
Contains PowerPoint configuration for exporting a dashboard.
PowerPointExportOptions() - Constructor for class io.revealbi.core.PowerPointExportOptions
Creates a new PowerPointExportOptions instance with default settings.
PowerPointExportOptions(IExportOptions) - Constructor for class io.revealbi.core.PowerPointExportOptions
Creates a new PowerPointExportOptions by copying settings from an existing IExportOptions instance.
PREVIOUS - Enum constant in enum class io.revealbi.core.RVPeriodRelation
Previous [period] = beginning of last [period] until end of last [period].
PREVIOUS_MONTH - Enum constant in enum class io.revealbi.core.RVDateFilterType
The previous month
PREVIOUS_QUARTER - Enum constant in enum class io.revealbi.core.RVDateFilterType
The previous quarter
PREVIOUS_YEAR - Enum constant in enum class io.revealbi.core.RVDateFilterType
The previous year
process(IHttpRequest, IHttpResponse, IRVUserContext) - Method in class io.revealbi.core.impl.RevealServer
 
process(IHttpRequest, IHttpResponse, IRVUserContext) - Method in interface io.revealbi.core.IRevealServer
Processes a Reveal server request.
PROFILES - Enum constant in enum class io.revealbi.core.data.RVGoogleAnalyticsResourceType
A Google Analytics profiles resource.
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVAnalysisServicesDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVAthenaDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVAzureAnalysisServicesDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVAzureCosmosDBDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVAzureSqlDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVAzureSynapseDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVBigQueryDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVBoxDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVClickHouseDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVCsvDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVDatabricksDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVDropboxDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVDynamicsCrmDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVElasticsearchDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVExcelDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVGoogleAnalytics4DataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVGoogleDriveDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVGoogleSearchConsoleDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVGoogleSheetDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVHubspotDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVInMemoryDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVJsonDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVLocalFileDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVMarketoDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVMongoDBDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVMySqlDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVODataDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVOneDriveDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVOracleDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVPostgresDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVQuickBooksDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVRedshiftDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVReportingServicesDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVRESTDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVS3DataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVSharePointDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVSnowflakeDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVSqlServerDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVSyBaseDataSource
 
PROVIDER_KEY - Static variable in class io.revealbi.core.data.RVWebResourceDataSource
 

Q

QUARTER - Enum constant in enum class io.revealbi.core.RVPeriodType
Quarter
QUARTER_TO_DATE - Enum constant in enum class io.revealbi.core.RVDateFilterType
From the first day of the current quarter

R

REDIS_OPTIONS - Static variable in class io.revealbi.core.RevealEngineConstants
Setting key for the Redis connection options used when Redis caching is configured.
REPORT - Enum constant in enum class io.revealbi.core.data.RVGoogleAnalyticsResourceType
A Google Analytics report resource.
REPORT - Enum constant in enum class io.revealbi.core.data.RVReportingServicesRenderMode
Render the report as a formatted document (exported to PDF).
resolveCredentials(IRVUserContext, RVDashboardDataSource) - Method in interface io.revealbi.core.data.IRVAuthenticationProvider
Returns the credentials to use for this data source, null means there are no credentials associated and the data loading process will fail.
RevealEngineConstants - Class in io.revealbi.core
Defines Reveal engine setting keys.
RevealEngineConstants() - Constructor for class io.revealbi.core.RevealEngineConstants
 
RevealEngineServlet - Class in io.revealbi.servlet
 
RevealEngineServlet(IRevealServer) - Constructor for class io.revealbi.servlet.RevealEngineServlet
 
RevealEngineServlet(IRevealServer, IRVServletUserContextProvider) - Constructor for class io.revealbi.servlet.RevealEngineServlet
 
RevealEngineServlet(Supplier<IRevealServer>) - Constructor for class io.revealbi.servlet.RevealEngineServlet
 
RevealEngineServlet(Supplier<IRevealServer>, IRVServletUserContextProvider) - Constructor for class io.revealbi.servlet.RevealEngineServlet
 
RevealPlugin - Class in io.revealbi.core
 
RevealPlugin(String, String, String) - Constructor for class io.revealbi.core.RevealPlugin
 
RevealPlugin(String, String, String, Map<String, Object>, Map<String, RevealPluginCallback>) - Constructor for class io.revealbi.core.RevealPlugin
 
RevealPluginCallback - Interface in io.revealbi.core
 
RevealServer - Class in io.revealbi.core.impl
 
RevealServer(RevealSettings, IRVAuthenticationProvider, IRVDashboardProvider, IRVDataSourceProvider, IRVDataProvider, IRVObjectFilter, IRVDataModelProvider, IRVSystemUserContextProvider) - Constructor for class io.revealbi.core.impl.RevealServer
 
RevealServerBuilder - Class in io.revealbi.core
Builds instances of IRevealServer.
RevealServerBuilder() - Constructor for class io.revealbi.core.RevealServerBuilder
 
RevealSettings - Class in io.revealbi.core
Contains Reveal server settings.
RevealSettings() - Constructor for class io.revealbi.core.RevealSettings
 
RVAmazonWebServicesCredentials - Class in io.revealbi.core.data
The class used to represent authentication for AWS, like required by data sources like Athena or S3.
RVAmazonWebServicesCredentials(String, String) - Constructor for class io.revealbi.core.data.RVAmazonWebServicesCredentials
Creates AWS credentials with access key and secret (no session token).
RVAmazonWebServicesCredentials(String, String, String) - Constructor for class io.revealbi.core.data.RVAmazonWebServicesCredentials
Creates AWS credentials with access key, secret and an optional session token (for temporary credentials).
RVAnalysisServicesDataSource - Class in io.revealbi.core.data
Abstract base class for Microsoft Analysis Services (MS SSAS) data sources.
RVAnalysisServicesDataSource() - Constructor for class io.revealbi.core.data.RVAnalysisServicesDataSource
 
RVAnalysisServicesDataSourceItem - Class in io.revealbi.core.data
Microsoft Analysis Services (MS SSAS) item, specifies the cube to get data from.
RVAnalysisServicesDataSourceItem(RVAnalysisServicesDataSource) - Constructor for class io.revealbi.core.data.RVAnalysisServicesDataSourceItem
 
RVAthenaDataSource - Class in io.revealbi.core.data
Amazon Athena data source
RVAthenaDataSource() - Constructor for class io.revealbi.core.data.RVAthenaDataSource
 
RVAthenaDataSourceItem - Class in io.revealbi.core.data
Amazon Athena data source item.
RVAthenaDataSourceItem(RVAthenaDataSource) - Constructor for class io.revealbi.core.data.RVAthenaDataSourceItem
 
RVAzureAnalysisServicesDataSource - Class in io.revealbi.core.data
Microsoft Azure Analysis Services data source.
RVAzureAnalysisServicesDataSource() - Constructor for class io.revealbi.core.data.RVAzureAnalysisServicesDataSource
 
RVAzureCosmosDBConnectionMode - Enum Class in io.revealbi.core.data
Specifies the connection mode used to communicate with the Azure CosmosDB service.
RVAzureCosmosDBDataSource - Class in io.revealbi.core.data
Azure CosmosDB data source.
RVAzureCosmosDBDataSource() - Constructor for class io.revealbi.core.data.RVAzureCosmosDBDataSource
 
RVAzureCosmosDBDataSourceItem - Class in io.revealbi.core.data
Azure CosmosDB data source item
RVAzureCosmosDBDataSourceItem(RVAzureCosmosDBDataSource) - Constructor for class io.revealbi.core.data.RVAzureCosmosDBDataSourceItem
 
RVAzureSqlDataSource - Class in io.revealbi.core.data
Azure SQL Server data source
RVAzureSqlDataSource() - Constructor for class io.revealbi.core.data.RVAzureSqlDataSource
 
RVAzureSqlDataSourceItem - Class in io.revealbi.core.data
Azure SQL Server data source item.
RVAzureSqlDataSourceItem(RVAzureSqlDataSource) - Constructor for class io.revealbi.core.data.RVAzureSqlDataSourceItem
 
RVAzureSynapseDataSource - Class in io.revealbi.core.data
Azure Synapse data source.
RVAzureSynapseDataSource() - Constructor for class io.revealbi.core.data.RVAzureSynapseDataSource
 
RVAzureSynapseDataSourceItem - Class in io.revealbi.core.data
Azure Synapse data source item.
RVAzureSynapseDataSourceItem(RVAzureSynapseDataSource) - Constructor for class io.revealbi.core.data.RVAzureSynapseDataSourceItem
 
RVBaseSharePointDataSourceItem - Class in io.revealbi.core.data
The base abstract class for data source items from Sharepoint.
RVBaseSharePointDataSourceItem(RVSharePointDataSource) - Constructor for class io.revealbi.core.data.RVBaseSharePointDataSourceItem
 
RVBearerTokenDataSourceCredential - Class in io.revealbi.core.data
The class used to represent Bearer (aka 'Token') authentication.
RVBearerTokenDataSourceCredential(String, String) - Constructor for class io.revealbi.core.data.RVBearerTokenDataSourceCredential
Creates credentials with the specified attributes.
RVBigQueryDataSource - Class in io.revealbi.core.data
BigQuery data source.
RVBigQueryDataSource() - Constructor for class io.revealbi.core.data.RVBigQueryDataSource
 
RVBigQueryDataSourceItem - Class in io.revealbi.core.data
BigQuery data source item.
RVBigQueryDataSourceItem(RVBigQueryDataSource) - Constructor for class io.revealbi.core.data.RVBigQueryDataSourceItem
 
RVBoxDataSource - Class in io.revealbi.core.data
Box (box.net) data source.
RVBoxDataSource() - Constructor for class io.revealbi.core.data.RVBoxDataSource
 
RVBoxDataSourceItem - Class in io.revealbi.core.data
Box data source item, referencing a file in Box (box.net).
RVBoxDataSourceItem() - Constructor for class io.revealbi.core.data.RVBoxDataSourceItem
 
RVClickHouseDataSource - Class in io.revealbi.core.data
ClickHouse data source.
RVClickHouseDataSource() - Constructor for class io.revealbi.core.data.RVClickHouseDataSource
 
RVClickHouseDataSourceItem - Class in io.revealbi.core.data
ClickHouse data source item.
RVClickHouseDataSourceItem(RVClickHouseDataSource) - Constructor for class io.revealbi.core.data.RVClickHouseDataSourceItem
 
RVCsvDataSource - Class in io.revealbi.core.data
The data source object used to represent the CSV data source, there are no additional properties in this class as all relevant information is specified in the RVCsvDataSourceItem object.
RVCsvDataSource() - Constructor for class io.revealbi.core.data.RVCsvDataSource
 
RVCsvDataSourceItem - Class in io.revealbi.core.data
The data source item used to represent a dataset from a CSV file, it includes optional settings like the separator to use when parsing the data.
RVCsvDataSourceItem(IRVResourceItem) - Constructor for class io.revealbi.core.data.RVCsvDataSourceItem
Creates a new CSV item getting data from the specified resource item.
RVDashboardAggregationType - Enum Class in io.revealbi.core.data
Aggregation type to use for a data model field.
RVDashboardDataSource - Class in io.revealbi.core.data
The base class representing a data source used in a dashboard, you can see RVDataSourceItem for more information about the relationship between data source and data source items.
RVDashboardDataSource() - Constructor for class io.revealbi.core.data.RVDashboardDataSource
 
RVDashboardDataType - Enum Class in io.revealbi.core.data
The list of dashboard data types.
RVDashboardFilter - Class in io.revealbi.core
Class used to represent a dashboard filter
RVDashboardFilter(String, String) - Constructor for class io.revealbi.core.RVDashboardFilter
Creates a new RVDashboardFilter with the given title and ID.
RVDashboardProvider - Class in io.revealbi.core
Default file system based implementation of IRVDashboardProvider loading/saving .rdash files from a specified (through the constructor) directory.
RVDashboardProvider() - Constructor for class io.revealbi.core.RVDashboardProvider
Creates a new RVDashboardProvider using the default dashboards directory.
RVDashboardProvider(String) - Constructor for class io.revealbi.core.RVDashboardProvider
Creates a new RVDashboardProvider.
RVDatabricksDataSource - Class in io.revealbi.core.data
Databricks data source.
RVDatabricksDataSource() - Constructor for class io.revealbi.core.data.RVDatabricksDataSource
 
RVDatabricksDataSourceItem - Class in io.revealbi.core.data
Databricks data source item.
RVDatabricksDataSourceItem(RVDatabricksDataSource) - Constructor for class io.revealbi.core.data.RVDatabricksDataSourceItem
 
RVDataModelCalculatedField - Class in io.revealbi.core.data
Represents a calculated field in the data model.
RVDataModelCalculatedField(String, RVDashboardDataType, String) - Constructor for class io.revealbi.core.data.RVDataModelCalculatedField
Creates a new calculated field with the given name, type, and expression.
RVDataModelField - Class in io.revealbi.core.data
Represents a field in the data model.
RVDataModelField(String, RVDashboardDataType) - Constructor for class io.revealbi.core.data.RVDataModelField
Creates a new data model field with the given name and type.
RVDataModelMeasure - Class in io.revealbi.core.data
Represents a custom measure in the data model.
RVDataModelMeasure(String, String) - Constructor for class io.revealbi.core.data.RVDataModelMeasure
Creates a new measure with the given name and expression.
RVDataSourceItem - Class in io.revealbi.core.data
The basic class for data source items that can be used by visualizations to get data.
RVDataSourceItem(RVDashboardDataSource) - Constructor for class io.revealbi.core.data.RVDataSourceItem
 
RVDateDashboardFilter - Class in io.revealbi.core
Class representing the optional date filter defined in a dashboard model.
RVDateDashboardFilter(RVDateFilterType) - Constructor for class io.revealbi.core.RVDateDashboardFilter
Creates a new date filter with the specified filter type.
RVDateDashboardFilter(RVDateFilterType, RVDateRange) - Constructor for class io.revealbi.core.RVDateDashboardFilter
Creates a new date filter with the specified type and custom range, this is the constructor that should be used with RVDateFilterType.CUSTOM_RANGE.
RVDateDashboardFilter(RVDateRange) - Constructor for class io.revealbi.core.RVDateDashboardFilter
Creates a new date filter with the specified custom range.
RVDateDashboardFilter(RVDateRule) - Constructor for class io.revealbi.core.RVDateDashboardFilter
Creates a new date filter with the specified rule.
RVDateDashboardFilter(String, RVDateFilterType) - Constructor for class io.revealbi.core.RVDateDashboardFilter
Creates a new date filter with the specified filter type.
RVDateDashboardFilter(String, RVDateFilterType, RVDateRange) - Constructor for class io.revealbi.core.RVDateDashboardFilter
Creates a new date filter with the specified type and custom range, this is the constructor that should be used with RVDateFilterType.CUSTOM_RANGE.
RVDateDashboardFilter(String, RVDateRange) - Constructor for class io.revealbi.core.RVDateDashboardFilter
Creates a new date filter with the specified custom range.
RVDateDashboardFilter(String, RVDateRule) - Constructor for class io.revealbi.core.RVDateDashboardFilter
Creates a new date filter with the specified title and rule.
RVDateFilterType - Enum Class in io.revealbi.core
Date filter type, you can use one of the predefined filters or the custom range type.
RVDateRange - Class in io.revealbi.core
Class used to represent a date range for filtering.
RVDateRange() - Constructor for class io.revealbi.core.RVDateRange
Creates a new date range with null values for From and To properties
RVDateRange(Calendar, Calendar) - Constructor for class io.revealbi.core.RVDateRange
Creates a new date range with the specified values for From and To properties
RVDateRule - Class in io.revealbi.core
A class that represents a date rule for a filter.
RVDateRule(RVPeriodRelation, int, RVPeriodType) - Constructor for class io.revealbi.core.RVDateRule
Create a date rule with the specified period relation, count and period type.
RVDateRule(RVPeriodRelation, RVPeriodType) - Constructor for class io.revealbi.core.RVDateRule
Create a date rule with the specified period relation and period type.
RVDropboxDataSource - Class in io.revealbi.core.data
Dropbox data source.
RVDropboxDataSource() - Constructor for class io.revealbi.core.data.RVDropboxDataSource
 
RVDropboxDataSourceItem - Class in io.revealbi.core.data
Dropbox data source item, referencing a file in Dropbox.
RVDropboxDataSourceItem() - Constructor for class io.revealbi.core.data.RVDropboxDataSourceItem
 
RVDynamicsCrmDataSource - Class in io.revealbi.core.data
Dynamics CRM data source, specifies the URL to the server.
RVDynamicsCrmDataSource() - Constructor for class io.revealbi.core.data.RVDynamicsCrmDataSource
 
RVDynamicsCrmDataSourceItem - Class in io.revealbi.core.data
Dynamics CRM data source item.
RVDynamicsCrmDataSourceItem(RVDynamicsCrmDataSource) - Constructor for class io.revealbi.core.data.RVDynamicsCrmDataSourceItem
 
RVElasticsearchDataSource - Class in io.revealbi.core.data
Elasticsearch data source.
RVElasticsearchDataSource() - Constructor for class io.revealbi.core.data.RVElasticsearchDataSource
 
RVElasticsearchDataSourceItem - Class in io.revealbi.core.data
Elasticsearch data source item
RVElasticsearchDataSourceItem(RVElasticsearchDataSource) - Constructor for class io.revealbi.core.data.RVElasticsearchDataSourceItem
 
RVExcelDataSource - Class in io.revealbi.core.data
The data source object used to represent the Excel data source, there are no additional properties in this class as all relevant information is specified in the RVExcelDataSourceItem object.
RVExcelDataSource() - Constructor for class io.revealbi.core.data.RVExcelDataSource
 
RVExcelDataSourceItem - Class in io.revealbi.core.data
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.
RVExcelDataSourceItem(IRVResourceItem) - Constructor for class io.revealbi.core.data.RVExcelDataSourceItem
 
RVExcelRange - Class in io.revealbi.core.data
Class defining the range that should be used when loading data from an Excel sheet.
RVExcelRange(int, int, int, int) - Constructor for class io.revealbi.core.data.RVExcelRange
Creates an Excel range with the given starting position and dimensions.
RVGoogleAnalytics4DataSource - Class in io.revealbi.core.data
Google Analytics 4 data source.
RVGoogleAnalytics4DataSource() - Constructor for class io.revealbi.core.data.RVGoogleAnalytics4DataSource
 
RVGoogleAnalytics4DataSourceItem - Class in io.revealbi.core.data
Google Analytics 4 data source item.
RVGoogleAnalytics4DataSourceItem(RVGoogleAnalytics4DataSource) - Constructor for class io.revealbi.core.data.RVGoogleAnalytics4DataSourceItem
 
RVGoogleAnalyticsResourceType - Enum Class in io.revealbi.core.data
Specifies the type of Google Analytics resource to access.
RVGoogleDriveDataSource - Class in io.revealbi.core.data
Google Drive data source.
RVGoogleDriveDataSource() - Constructor for class io.revealbi.core.data.RVGoogleDriveDataSource
 
RVGoogleDriveDataSourceItem - Class in io.revealbi.core.data
Google Drive data source item, referencing a file in Google Drive.
RVGoogleDriveDataSourceItem() - Constructor for class io.revealbi.core.data.RVGoogleDriveDataSourceItem
 
RVGoogleSearchConsoleDataSource - Class in io.revealbi.core.data
Google Search Console data source.
RVGoogleSearchConsoleDataSource() - Constructor for class io.revealbi.core.data.RVGoogleSearchConsoleDataSource
 
RVGoogleSearchConsoleDataSourceItem - Class in io.revealbi.core.data
Google Search Console data source item.
RVGoogleSearchConsoleDataSourceItem(RVGoogleSearchConsoleDataSource) - Constructor for class io.revealbi.core.data.RVGoogleSearchConsoleDataSourceItem
 
RVGoogleSheetDataSource - Class in io.revealbi.core.data
The data source object used to represent the Google sheet data source, there are no additional properties in this class as all relevant information is specified in the RVGoogleSheetDataSourceItem object.
RVGoogleSheetDataSource() - Constructor for class io.revealbi.core.data.RVGoogleSheetDataSource
 
RVGoogleSheetDataSourceItem - Class in io.revealbi.core.data
The data source item used to represent a dataset from a Google Sheet file, it includes information like the name of the sheet to get data from and the range to use when loading data.
RVGoogleSheetDataSourceItem(IRVResourceItem) - Constructor for class io.revealbi.core.data.RVGoogleSheetDataSourceItem
 
RVHeadersDataSourceCredentials - Class in io.revealbi.core.data
The class used to represent authentication using headers (including cookies), supported only by Web Resource and REST API data sources.
RVHeadersDataSourceCredentials() - Constructor for class io.revealbi.core.data.RVHeadersDataSourceCredentials
Creates an empty headers credentials object, you can use RVHeadersDataSourceCredentials.addHeader(String, String) to add headers.
RVHeadersDataSourceCredentials(String, String) - Constructor for class io.revealbi.core.data.RVHeadersDataSourceCredentials
Helper constructor to create a headers credentials with a single header, you can add additional headers with RVHeadersDataSourceCredentials.addHeader(String, String).
RVHeadersDataSourceCredentials(Map<String, String>) - Constructor for class io.revealbi.core.data.RVHeadersDataSourceCredentials
Constructor used to indicate the headers that should be included in data requests.
RVHttpAnalysisServicesDataSource - Class in io.revealbi.core.data
Microsoft Analysis Services (MS SSAS) HTTP connection data source
RVHttpAnalysisServicesDataSource() - Constructor for class io.revealbi.core.data.RVHttpAnalysisServicesDataSource
 
RVHubspotDataSource - Class in io.revealbi.core.data
HubSpot data source.
RVHubspotDataSource() - Constructor for class io.revealbi.core.data.RVHubspotDataSource
 
RVHubspotDataSourceItem - Class in io.revealbi.core.data
HubSpot data source item, referencing HubSpot entity.
RVHubspotDataSourceItem() - Constructor for class io.revealbi.core.data.RVHubspotDataSourceItem
 
RVInMemoryDataSource - Class in io.revealbi.core.data
The data source object used to represent the in-memory data source, there are no additional properties in this class as all relevant information is specified in the RVInMemoryDataSourceItem object.
RVInMemoryDataSource() - Constructor for class io.revealbi.core.data.RVInMemoryDataSource
 
RVInMemoryDataSourceItem - Class in io.revealbi.core.data
Data source item to get in-memory data.
RVInMemoryDataSourceItem(String) - Constructor for class io.revealbi.core.data.RVInMemoryDataSourceItem
Used to create a new in-memory item with the specified dataset id.
RVIntegratedAuthenticationCredential - Class in io.revealbi.core.data
Used to indicate integrated authentication.
RVIntegratedAuthenticationCredential() - Constructor for class io.revealbi.core.data.RVIntegratedAuthenticationCredential
 
RVJsonDataSource - Class in io.revealbi.core.data
The data source object used to represent the JSON data source, there are no additional properties in this class as all relevant information is specified in the RVJsonDataSourceItem object.
RVJsonDataSource() - Constructor for class io.revealbi.core.data.RVJsonDataSource
 
RVJsonDataSourceItem - Class in io.revealbi.core.data
The data source item used to represent a dataset from a JSON file, it includes the optional parsing configuration.
RVJsonDataSourceItem(IRVResourceItem) - Constructor for class io.revealbi.core.data.RVJsonDataSourceItem
Creates a new JSON item getting data from the specified resource item.
RVKeyPairDataSourceCredential - Class in io.revealbi.core.data
Used for key-pair authentication.
RVKeyPairDataSourceCredential(String, String) - Constructor for class io.revealbi.core.data.RVKeyPairDataSourceCredential
Creates credentials with the user name and the private key.
RVLocalFileDataSource - Class in io.revealbi.core.data
The data source object used to represent the local files data source, there are no additional properties in this class as all relevant information is specified in the RVLocalFileDataSourceItem object.
RVLocalFileDataSource() - Constructor for class io.revealbi.core.data.RVLocalFileDataSource
 
RVLocalFileDataSourceItem - Class in io.revealbi.core.data
The local file data source item, used to load files from local storage.
RVLocalFileDataSourceItem() - Constructor for class io.revealbi.core.data.RVLocalFileDataSourceItem
 
RVMarketoDataSource - Class in io.revealbi.core.data
Marketo data source, configures the URL to get data from.
RVMarketoDataSource() - Constructor for class io.revealbi.core.data.RVMarketoDataSource
 
RVMarketoDataSourceItem - Class in io.revealbi.core.data
Marketo data source item, see RVMarketoDataSource for more information.
RVMarketoDataSourceItem(RVMarketoDataSource) - Constructor for class io.revealbi.core.data.RVMarketoDataSourceItem
 
RVMicrosoftEntraIDDataSourceCredential - Class in io.revealbi.core.data
Used for Microsoft Entra ID authentication.
RVMicrosoftEntraIDDataSourceCredential(String, String, String) - Constructor for class io.revealbi.core.data.RVMicrosoftEntraIDDataSourceCredential
Creates Microsoft Entra ID (Azure AD) credentials for client credentials flow.
RVMongoDBDataSource - Class in io.revealbi.core.data
MongoDB data source
RVMongoDBDataSource() - Constructor for class io.revealbi.core.data.RVMongoDBDataSource
 
RVMongoDBDataSourceItem - Class in io.revealbi.core.data
Data source item for MongoDB.
RVMongoDBDataSourceItem(RVMongoDBDataSource) - Constructor for class io.revealbi.core.data.RVMongoDBDataSourceItem
 
RVMySqlDataSource - Class in io.revealbi.core.data
MySQL data source.
RVMySqlDataSource() - Constructor for class io.revealbi.core.data.RVMySqlDataSource
 
RVMySqlDataSourceItem - Class in io.revealbi.core.data
MySQL data source item
RVMySqlDataSourceItem(RVMySqlDataSource) - Constructor for class io.revealbi.core.data.RVMySqlDataSourceItem
 
RVNativeAnalysisServicesDataSource - Class in io.revealbi.core.data
Microsoft Analysis Services (MS SSAS) TCP connection data source.
RVNativeAnalysisServicesDataSource() - Constructor for class io.revealbi.core.data.RVNativeAnalysisServicesDataSource
 
RVOAuthDataSourceCredential - Class in io.revealbi.core.data
Used for OAuth Client Credentials authentication.
RVOAuthDataSourceCredential(String, String) - Constructor for class io.revealbi.core.data.RVOAuthDataSourceCredential
Creates OAuth client credentials with the specified client ID and secret.
RVODataDataSource - Class in io.revealbi.core.data
OData data source, configures the URL to get data from.
RVODataDataSource() - Constructor for class io.revealbi.core.data.RVODataDataSource
 
RVODataDataSourceItem - Class in io.revealbi.core.data
OData data source item, see RVODataDataSource for more information.
RVODataDataSourceItem(RVODataDataSource) - Constructor for class io.revealbi.core.data.RVODataDataSourceItem
 
RVOneDriveDataSource - Class in io.revealbi.core.data
OneDrive data source.
RVOneDriveDataSource() - Constructor for class io.revealbi.core.data.RVOneDriveDataSource
 
RVOneDriveDataSourceItem - Class in io.revealbi.core.data
OneDrive data source item, referencing a file in OneDrive.
RVOneDriveDataSourceItem() - Constructor for class io.revealbi.core.data.RVOneDriveDataSourceItem
 
RVOneDriveDataSourceItem(RVOneDriveDataSource) - Constructor for class io.revealbi.core.data.RVOneDriveDataSourceItem
 
RVOracleDataSource - Class in io.revealbi.core.data
Abstract base class for Oracle data sources.
RVOracleDataSource() - Constructor for class io.revealbi.core.data.RVOracleDataSource
 
RVOracleDataSourceItem - Class in io.revealbi.core.data
Oracle data source item.
RVOracleDataSourceItem(RVOracleDataSource) - Constructor for class io.revealbi.core.data.RVOracleDataSourceItem
 
RVOracleServiceDataSource - Class in io.revealbi.core.data
Oracle data source, it adds the Service name property to the base properties in RVOracleDataSource.
RVOracleServiceDataSource() - Constructor for class io.revealbi.core.data.RVOracleServiceDataSource
 
RVOracleSIDDataSource - Class in io.revealbi.core.data
Oracle data source, it adds the SID property to the base properties in RVOracleDataSource.
RVOracleSIDDataSource() - Constructor for class io.revealbi.core.data.RVOracleSIDDataSource
 
RVPeriodRelation - Enum Class in io.revealbi.core
Represents the relation of a period to the current date, for use in date rules.
RVPeriodType - Enum Class in io.revealbi.core
Represents the type of period to be used by a date rule.
RVPersonalAccessTokenDataSourceCredential - Class in io.revealbi.core.data
Used for Personal Access Token (PAT) authentication.
RVPersonalAccessTokenDataSourceCredential(String) - Constructor for class io.revealbi.core.data.RVPersonalAccessTokenDataSourceCredential
Creates a personal access token credential.
RVPostgresDataSource - Class in io.revealbi.core.data
PostgreSQL data source, it adds database name and schema properties to the base properties in RVSqlPDSDataSource.
RVPostgresDataSource() - Constructor for class io.revealbi.core.data.RVPostgresDataSource
 
RVPostgresDataSourceItem - Class in io.revealbi.core.data
PostgreSQL data source item.
RVPostgresDataSourceItem(RVPostgresDataSource) - Constructor for class io.revealbi.core.data.RVPostgresDataSourceItem
 
RVQuickBooksDataSource - Class in io.revealbi.core.data
QuickBooks data source
RVQuickBooksDataSource() - Constructor for class io.revealbi.core.data.RVQuickBooksDataSource
 
RVQuickBooksDataSourceItem - Class in io.revealbi.core.data
Data source item for QuickBooks.
RVQuickBooksDataSourceItem(RVQuickBooksDataSource) - Constructor for class io.revealbi.core.data.RVQuickBooksDataSourceItem
 
RVRedisOptions - Class in io.revealbi.core
Represents configuration options for connecting to a Redis cache.
RVRedisOptions() - Constructor for class io.revealbi.core.RVRedisOptions
 
RVRedshiftDataSource - Class in io.revealbi.core.data
Amazon Redshift data source, it adds the database name property to the base properties in RVSqlBasedDataSource.
RVRedshiftDataSource() - Constructor for class io.revealbi.core.data.RVRedshiftDataSource
 
RVRedshiftDataSourceItem - Class in io.revealbi.core.data
Amazon Redshift data source item.
RVRedshiftDataSourceItem(RVRedshiftDataSource) - Constructor for class io.revealbi.core.data.RVRedshiftDataSourceItem
 
RVReportingServicesDataSource - Class in io.revealbi.core.data
Microsoft Reporting Services (MS SSRS) data source
RVReportingServicesDataSource() - Constructor for class io.revealbi.core.data.RVReportingServicesDataSource
 
RVReportingServicesDataSourceItem - Class in io.revealbi.core.data
Microsoft Reporting Services (MS SSRS) data source item.
RVReportingServicesDataSourceItem(RVReportingServicesDataSource) - Constructor for class io.revealbi.core.data.RVReportingServicesDataSourceItem
 
RVReportingServicesRenderMode - Enum Class in io.revealbi.core.data
Specifies the rendering mode used when exporting a Reporting Services report.
RVResourceBasedDataSourceItem - Class in io.revealbi.core.data
The base abstract class representing a data source item getting data from a file (a resource).
RVResourceBasedDataSourceItem(RVDashboardDataSource, IRVResourceItem) - Constructor for class io.revealbi.core.data.RVResourceBasedDataSourceItem
 
RVRESTDataSource - Class in io.revealbi.core.data
REST API data source, configures the URL to get data from, HTTP method to use and optionally headers and body to send in the request.
RVRESTDataSource() - Constructor for class io.revealbi.core.data.RVRESTDataSource
 
RVRESTDataSourceItem - Class in io.revealbi.core.data
REST API data source item.
RVRESTDataSourceItem(RVRESTDataSource) - Constructor for class io.revealbi.core.data.RVRESTDataSourceItem
 
RVS3DataSource - Class in io.revealbi.core.data
Amazon S3 data source.
RVS3DataSource() - Constructor for class io.revealbi.core.data.RVS3DataSource
 
RVS3DataSourceItem - Class in io.revealbi.core.data
Amazon S3 data source item.
RVS3DataSourceItem(RVS3DataSource) - Constructor for class io.revealbi.core.data.RVS3DataSourceItem
 
RVSchemaColumn - Class in io.revealbi.core.data
Describes a column in an in-memory dataset, specifying its field name, display label, and data type.
RVSchemaColumn(String, String, RVSchemaColumnType) - Constructor for class io.revealbi.core.data.RVSchemaColumn
Creates a new schema column with the desired field name, optional label and data type.
RVSchemaColumnType - Enum Class in io.revealbi.core.data
The list of data types supported by Reveal.
RVSharePointAuthenticationMethod - Enum Class in io.revealbi.core.data
SharePoint authentication methods.
RVSharePointDataSource - Class in io.revealbi.core.data
Sharepoint data source, contains the URL to the Sharepoint site to use.
RVSharePointDataSource() - Constructor for class io.revealbi.core.data.RVSharePointDataSource
 
RVSharePointItemType - Enum Class in io.revealbi.core.data
SharePoint item type.
RVSharePointListDataSourceItem - Class in io.revealbi.core.data
Data source item to get data from a Sharepoint list.
RVSharePointListDataSourceItem(RVSharePointDataSource) - Constructor for class io.revealbi.core.data.RVSharePointListDataSourceItem
 
RVSharePointListItemDataSourceItem - Class in io.revealbi.core.data
Data source item to get data from a single item in a Sharepoint list.
RVSharePointListItemDataSourceItem(RVSharePointDataSource) - Constructor for class io.revealbi.core.data.RVSharePointListItemDataSourceItem
 
RVSharePointPeopleDataSourceItem - Class in io.revealbi.core.data
Data source item to get data from people in Sharepoint.
RVSharePointPeopleDataSourceItem(RVSharePointDataSource) - Constructor for class io.revealbi.core.data.RVSharePointPeopleDataSourceItem
 
RVSharePointSiteDataSourceItem - Class in io.revealbi.core.data
Data source item to show information from a site (or sub site).
RVSharePointSiteDataSourceItem(RVSharePointDataSource) - Constructor for class io.revealbi.core.data.RVSharePointSiteDataSourceItem
 
RVSnowflakeDataSource - Class in io.revealbi.core.data
Snowflake data source.
RVSnowflakeDataSource() - Constructor for class io.revealbi.core.data.RVSnowflakeDataSource
 
RVSnowflakeDataSourceItem - Class in io.revealbi.core.data
Snowflake data source item
RVSnowflakeDataSourceItem(RVSnowflakeDataSource) - Constructor for class io.revealbi.core.data.RVSnowflakeDataSourceItem
 
RVSqlBasedDataSource - Class in io.revealbi.core.data
The base data source class used to represent a connection to one of the supported database systems.
RVSqlBasedDataSource() - Constructor for class io.revealbi.core.data.RVSqlBasedDataSource
 
RVSqlBasedDataSourceItem - Class in io.revealbi.core.data
The base item class used to represent a dataset from one of the supported database systems.
RVSqlBasedDataSourceItem(RVDashboardDataSource) - Constructor for class io.revealbi.core.data.RVSqlBasedDataSourceItem
 
RVSqlPDSDataSource - Class in io.revealbi.core.data
Base class for SQL-based data sources supporting "Server-side Processing".
RVSqlPDSDataSource() - Constructor for class io.revealbi.core.data.RVSqlPDSDataSource
 
RVSqlPDSDataSourceItem - Class in io.revealbi.core.data
Base data source item class for SQL-based data sources supporting "Server-side Processing".
RVSqlPDSDataSourceItem(RVSqlPDSDataSource) - Constructor for class io.revealbi.core.data.RVSqlPDSDataSourceItem
 
RVSqlServerDataSource - Class in io.revealbi.core.data
Microsoft SQL Server data source, it adds the database name property to the base properties in RVSqlBasedDataSource.
RVSqlServerDataSource() - Constructor for class io.revealbi.core.data.RVSqlServerDataSource
 
RVSqlServerDataSourceItem - Class in io.revealbi.core.data
Microsoft SQL Server data source item.
RVSqlServerDataSourceItem(RVSqlServerDataSource) - Constructor for class io.revealbi.core.data.RVSqlServerDataSourceItem
 
RVSyBaseDataSource - Class in io.revealbi.core.data
Sybase data source, it adds the database name property to the base properties in RVSqlBasedDataSource.
RVSyBaseDataSource() - Constructor for class io.revealbi.core.data.RVSyBaseDataSource
 
RVSyBaseDataSourceItem - Class in io.revealbi.core.data
Sybase data source item.
RVSyBaseDataSourceItem(RVSyBaseDataSource) - Constructor for class io.revealbi.core.data.RVSyBaseDataSourceItem
 
RVUserContext - Class in io.revealbi.core
Default implementation of the IRVUserContext interface.
RVUserContext(String) - Constructor for class io.revealbi.core.RVUserContext
Creates a new RVUserContext with the given user ID and no additional properties.
RVUserContext(String, Map<String, Object>) - Constructor for class io.revealbi.core.RVUserContext
Creates a new RVUserContext with the given user ID and a map of additional properties.
RVUsernamePasswordDataSourceCredential - Class in io.revealbi.core.data
The class used to represent domain/user/password credentials, required to connect to all data bases (MS SQL, MySQL, etc) and some other data sources (REST API for example).
RVUsernamePasswordDataSourceCredential() - Constructor for class io.revealbi.core.data.RVUsernamePasswordDataSourceCredential
Constructor used to indicate that anonymous credentials or current system user (for MS SQLServer or MS SSAS) needs to be used
RVUsernamePasswordDataSourceCredential(String, String) - Constructor for class io.revealbi.core.data.RVUsernamePasswordDataSourceCredential
Creates credentials with no domain
RVUsernamePasswordDataSourceCredential(String, String, String) - Constructor for class io.revealbi.core.data.RVUsernamePasswordDataSourceCredential
Creates credentials with the specified attributes
RVWebResourceDataSource - Class in io.revealbi.core.data
Web resource data source, used to download files from HTTP URL's using GET method.
RVWebResourceDataSource() - Constructor for class io.revealbi.core.data.RVWebResourceDataSource
 
RVWebResourceDataSourceItem - Class in io.revealbi.core.data
Web resource data source item, see RVWebResourceDataSource for more information.
RVWebResourceDataSourceItem(RVWebResourceDataSource) - Constructor for class io.revealbi.core.data.RVWebResourceDataSourceItem
 

S

saveDashboard(IRVUserContext, String, InputStream) - Method in interface io.revealbi.core.IRVDashboardProvider
Saves the dashboard with the given dashboardId for the given user.
saveDashboard(IRVUserContext, String, InputStream) - Method in class io.revealbi.core.RVDashboardProvider
Saves a dashboard at the provided in the constructor location on the file system.
schema - Variable in class io.revealbi.core.impl.serializers.DataModelSerializer.EditSchemaRequest
 
SEMESTER - Enum constant in enum class io.revealbi.core.RVPeriodType
Semester
serialize(IRVDataSourceCredential) - Method in class io.revealbi.core.impl.serializers.CredentialSerializer
 
serialize(RVDashboardDataSource) - Method in class io.revealbi.core.impl.serializers.DashboardDataSourceSerializer
 
serialize(RVDataSourceItem) - Method in class io.revealbi.core.impl.serializers.DataSourceItemSerializer
Serializes a data source item to JSON string.
serializeCalculatedFields(List<RVDataModelCalculatedField>) - Method in class io.revealbi.core.impl.serializers.DataModelSerializer
Serializes a list of RVDataModelCalculatedField instances to a JSON string.
serializeFields(List<RVDataModelField>) - Method in class io.revealbi.core.impl.serializers.DataModelSerializer
Serializes a list of RVDataModelField instances to a JSON string.
serializeMeasures(List<RVDataModelMeasure>) - Method in class io.revealbi.core.impl.serializers.DataModelSerializer
Serializes a list of RVDataModelMeasure instances to a JSON string.
service(HttpServletRequest, HttpServletResponse) - Method in class io.revealbi.servlet.RevealEngineServlet
 
setAbortOnConnectFail(Boolean) - Method in class io.revealbi.core.RVRedisOptions
Sets whether the connection should abort immediately on a connection failure.
setAcceptAnyServerCertificate(boolean) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
When set to true, the HTTP client accepts any server certificate without validation.
setAccount(String) - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the account used to connect to Snowflake
setAccountEndpoint(String) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets or sets the URI of the Azure CosmosDB account endpoint (e.g.
setAccountId(String) - Method in class io.revealbi.core.data.RVGoogleAnalytics4DataSourceItem
Account identifier to get data from.
setAdvancedSetting(String, Object) - Method in class io.revealbi.core.RevealSettings
Sets an advanced setting value.
setAllowAdmin(Boolean) - Method in class io.revealbi.core.RVRedisOptions
Sets whether admin commands (e.g., FLUSHDB, CONFIG) are allowed.
setApplicationRegion(String) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets or sets the preferred Azure region for read and write operations.
setAssetContentType(String) - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Content-type of the item.
setAsyncTimeoutMs(Integer) - Method in class io.revealbi.core.RVRedisOptions
Sets the asynchronous operation timeout in milliseconds.
setAuthenticationMethod(RVSharePointAuthenticationMethod) - Method in class io.revealbi.core.data.RVSharePointDataSource
The authentication method to use when connecting to Sharepoint.
setAuthenticationProvider(IRVAuthenticationProvider) - Method in class io.revealbi.core.RevealServerBuilder
The authentication provider that provides credentials for data sources.
setAuthor(String) - Method in class io.revealbi.core.DocumentExportOptions
Document author.
setAuthor(String) - Method in interface io.revealbi.core.IDocumentExportOptions
Document author.
setAWSAccountId(String) - Method in class io.revealbi.core.data.RVS3DataSource
Only for internal use.
setBody(String) - Method in class io.revealbi.core.data.RVRESTDataSource
Body to send, expected to be used only with POST and PUT methods.
setBrandGreenColor(int) - Method in class io.revealbi.core.DefaultDashboardTheme
Sets the brand green color.
setBrandingColor(int) - Method in class io.revealbi.core.DefaultDashboardTheme
Sets the branding color.
setBrandRedColor(int) - Method in class io.revealbi.core.DefaultDashboardTheme
Sets the brand red color.
setCacheEncryptionEnabled(Boolean) - Method in class io.revealbi.core.RevealSettings
setCacheEncryptionPassword(String) - Method in class io.revealbi.core.RevealSettings
setCachePath(String) - Method in class io.revealbi.core.RevealSettings
setCatalog(String) - Method in class io.revealbi.core.data.RVAnalysisServicesDataSource
The name of the catalog (database) to use.
setCatalog(String) - Method in class io.revealbi.core.data.RVAnalysisServicesDataSourceItem
The name of the catalog (database) containing the cube.
setCertificateFingerprint(String) - Method in class io.revealbi.core.data.RVElasticsearchDataSource
(Optional) Gets or sets the hex-encoded SHA-256 fingerprint of the Elasticsearch CA certificate used to establish trust for SSL/TLS connections.
setChromiumDownloadFolder(String) - Method in class io.revealbi.core.ExportConfiguration
Indicates the folder where Chromium will be downloaded.
setChromiumExecutablePath(String) - Method in class io.revealbi.core.ExportConfiguration
Path to Chromium executable file.
setClientName(String) - Method in class io.revealbi.core.RVRedisOptions
Sets the client name used to identify this connection in Redis.
setCollection(String) - Method in class io.revealbi.core.data.RVMongoDBDataSourceItem
Gets or sets the name of the collection.
setColor(int) - Method in class io.revealbi.core.DocumentExportOptions
Color used for titles underlines
setColor(int) - Method in interface io.revealbi.core.IDocumentExportOptions
Color used for titles underlines
setCompany(String) - Method in class io.revealbi.core.DocumentExportOptions
Company name displayed in the lower left corner
setCompany(String) - Method in interface io.revealbi.core.IDocumentExportOptions
Company name displayed in the lower left corner
setConfig(String) - Method in class io.revealbi.core.data.RVJsonDataSourceItem
The configuration of the JSON parser.
setConnectionMode(RVAzureCosmosDBConnectionMode) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets or sets the connection mode used to communicate with the CosmosDB service.
setConnectionString(String) - Method in class io.revealbi.core.data.RVMongoDBDataSource
Connection string for connecting to the MongoDB host.
setConnectionString(String) - Method in class io.revealbi.core.RVRedisOptions
Sets the Redis server connection string (e.g., "localhost:6379").
setConnectRetry(Integer) - Method in class io.revealbi.core.RVRedisOptions
Sets the number of connection retry attempts.
setConnectTimeoutMs(Integer) - Method in class io.revealbi.core.RVRedisOptions
Sets the connection timeout in milliseconds.
setContainer(String) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSourceItem
Gets or sets the name of the container.
setContentType(String) - Method in class io.revealbi.core.data.RVRESTDataSource
Content type of the body, only used when RVRESTDataSource.getBody() is not empty.
setCreateChromiumInstancesOnDemand(Boolean) - Method in class io.revealbi.core.ExportConfiguration
Indicates if Chromium instances are created when they are needed, or when application is started.
setCreatedBy(String) - Method in class io.revealbi.core.DocumentExportOptions
Deprecated.
setCreatedBy(String) - Method in class io.revealbi.core.ExcelExportOptions
Deprecated.
Deprecated: This property is no longer used in excel exports and will be removed in future versions.
setCube(String) - Method in class io.revealbi.core.data.RVAnalysisServicesDataSourceItem
Name of the cube to use
setCustomQuery(String) - Method in class io.revealbi.core.data.RVAthenaDataSourceItem
(Optional) Custom SQL query to use when getting data.
setCustomQuery(String) - Method in class io.revealbi.core.data.RVBigQueryDataSourceItem
(Optional) Custom SQL query to use when getting data.
setCustomQuery(String) - Method in class io.revealbi.core.data.RVDynamicsCrmDataSourceItem
Custom query to use when getting data from Dynamics CRM.
setCustomQuery(String) - Method in class io.revealbi.core.data.RVElasticsearchDataSourceItem
(Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.
setCustomQuery(String) - Method in class io.revealbi.core.data.RVMongoDBDataSourceItem
(Optional) Custom MongoDB query to use when getting data
setCustomQuery(String) - Method in class io.revealbi.core.data.RVSqlBasedDataSourceItem
(Optional) Custom SQL query to use when getting data.
setDashboardProvider(IRVDashboardProvider) - Method in class io.revealbi.core.RevealServerBuilder
The dashboard provider, used to load and save dashboards.
setDatabase(String) - Method in class io.revealbi.core.data.RVAthenaDataSource
Athena's database to use.
setDatabase(String) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Gets or sets the name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSourceItem
Gets or sets the name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVClickHouseDataSource
Name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVDatabricksDataSource
Sets the name of the database/catalog to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVMongoDBDataSource
Gets or sets the name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVMySqlDataSource
Name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVOracleDataSource
Name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVPostgresDataSource
Name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVRedshiftDataSource
Name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVSqlBasedDataSourceItem
Name of the database to connect to, optional as this value is usually specified in the data source object.
setDatabase(String) - Method in class io.revealbi.core.data.RVSqlServerDataSource
Name of the database to connect to.
setDatabase(String) - Method in class io.revealbi.core.data.RVSyBaseDataSource
Name of the database to connect to.
setDataCatalog(String) - Method in class io.revealbi.core.data.RVAthenaDataSource
Athena's data catalog where the database is.
setDataModelProvider(IRVDataModelProvider) - Method in class io.revealbi.core.RevealServerBuilder
Sets the data model provider used to customize the schema, calculated fields, and measures exposed by data sources.
setDataProvider(IRVDataProvider) - Method in class io.revealbi.core.RevealServerBuilder
The data provider, used for in-memory data sources.
setDatasetId(String) - Method in class io.revealbi.core.data.RVBigQueryDataSourceItem
BigQuery dataset.
setDatasetId(String) - Method in class io.revealbi.core.data.RVInMemoryDataSourceItem
String identifying this in-memory dataset, it might be used to decide what data to return.
setDataSource(RVDashboardDataSource) - Method in class io.revealbi.core.data.RVDataSourceItem
Reference to the data source object this item belongs to.
setDataSourceProvider(IRVDataSourceProvider) - Method in class io.revealbi.core.RevealServerBuilder
The data source provider, used to replace data sources in existing dashboards when they are opened.
setDateFormat(String) - Method in class io.revealbi.core.data.RVCsvDataSourceItem
Optional date format to use when parsing/detecting date columns, if not specified Reveal will try to infer the date format to use for each column (if it detects the column is a date, date time or time column).
setDefaultAggregation(RVDashboardAggregationType) - Method in class io.revealbi.core.data.RVDataModelField
Sets the default aggregation type for this field.
setDefaultDatabase(Integer) - Method in class io.revealbi.core.RVRedisOptions
Sets the default Redis database number to use.
setDefaultRefreshRate(Number) - Method in class io.revealbi.core.data.RVDashboardDataSource
Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g.
setDefaultRefreshRate(Number) - Method in class io.revealbi.core.data.RVDataSourceItem
Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g.
setDescription(String) - Method in class io.revealbi.core.data.RVDataModelField
Sets the description for the field.
setDescription(String) - Method in class io.revealbi.core.data.RVDataModelMeasure
Sets the description of the measure.
setDescription(String) - Method in class io.revealbi.core.data.RVDataSourceItem
Description of this data source item.
setDynamic(String) - Method in class io.revealbi.core.data.RVReportingServicesDataSourceItem
Sets the dynamic report path used to override the static path at runtime.
setEffectiveUserName(String) - Method in class io.revealbi.core.data.RVNativeAnalysisServicesDataSource
Optional user name to impersonate, in 'DOMAIN/username' format.
setEncoding(String) - Method in class io.revealbi.core.data.RVCsvDataSourceItem
The encoding to use, if not specified Reveal will try to detect it automatically.
setEncrypt(Boolean) - Method in class io.revealbi.core.data.RVSqlServerDataSource
If not null, the Encrypt flag will be set in the connection string to the specified value.
setEndDate(Calendar) - Method in class io.revealbi.core.data.RVHubspotDataSourceItem
End date to use when requesting data.
setEndDate(Calendar) - Method in class io.revealbi.core.data.RVMarketoDataSourceItem
End date to use when requesting data.
setEndPoints(List<String>) - Method in class io.revealbi.core.RVRedisOptions
Sets the list of endpoint URLs for connecting to Redis.
setEntity(String) - Method in class io.revealbi.core.data.RVDynamicsCrmDataSourceItem
Name of the entity to use.
setEntity(String) - Method in class io.revealbi.core.data.RVHubspotDataSourceItem
Entity to retrieve data from.
setEntity(String) - Method in class io.revealbi.core.data.RVMarketoDataSourceItem
Entity to retrieve data from.
setEntity(String) - Method in class io.revealbi.core.data.RVQuickBooksDataSourceItem
QuickBooks Entity.
setEntityType(String) - Method in class io.revealbi.core.data.RVODataDataSourceItem
Sets the OData entity type name used to map the response to a known schema.
setExcelVisualization(ExportExcelVisualization) - Method in class io.revealbi.core.ExcelExportOptions
Deprecated.
Deprecated: Please use VisualizationMode instead.
setExportingTimeout(Integer) - Method in class io.revealbi.core.ExportConfiguration
Indicates the time in ms to wait when exporting dashboard is called.
setExpression(String) - Method in class io.revealbi.core.data.RVDataModelCalculatedField
Sets the expression that defines this calculated field.
setFieldMultiValueLeniency(Boolean) - Method in class io.revealbi.core.data.RVElasticsearchDataSource
(Optional) Gets or sets the flag to control the behavior when SQL queries encounter fields with multiple values.
setFieldMultiValueLeniency(Boolean) - Method in class io.revealbi.core.data.RVElasticsearchDataSourceItem
(Optional) Controls behavior when SQL queries encounter fields with multiple values.
setFilters(ArrayList<IRVDashboardFilter>) - Method in class io.revealbi.core.ExportOptions
Dashboard filters applied during the export.
setFilters(ArrayList<IRVDashboardFilter>) - Method in interface io.revealbi.core.IExportOptions
Dashboard filters applied during the export.
setFirstRowContainsLabels(boolean) - Method in class io.revealbi.core.data.RVExcelDataSourceItem
If you set this flag to false the columns will be automatically named as 'COL1', 'COL2', etc.
setFolderRelativePath(String) - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Path relative to the folder containing the item.
setFunctionName(String) - Method in class io.revealbi.core.data.RVPostgresDataSourceItem
(Optional) name of the function to get data from, the function is expected to return a result set and might have multiple parameters.
setFunctionName(String) - Method in class io.revealbi.core.data.RVRedshiftDataSourceItem
(Optional) name of the function to get data from, the function is expected to return a result set and might have multiple parameters.
setFunctionParameters(HashMap) - Method in class io.revealbi.core.data.RVPostgresDataSourceItem
Parameters to be passed to the function, if there is such specified in RVPostgresDataSourceItem.getFunctionName().
setFunctionParameters(HashMap<String, Object>) - Method in class io.revealbi.core.data.RVRedshiftDataSourceItem
Parameters to be passed to the function, if there is such specified in RVRedshiftDataSourceItem.getFunctionName().
setFunctionQName(String) - Method in class io.revealbi.core.data.RVODataDataSourceItem
Sets the qualified name of the OData function or action to invoke.
setHeaders(ArrayList<String>) - Method in class io.revealbi.core.data.RVRESTDataSource
List of headers to send in the request, each string in this list is expected to be a string in the format name=value.
setHost(String) - Method in class io.revealbi.core.data.RVNativeAnalysisServicesDataSource
Hostname or IP address of the server
setHost(String) - Method in class io.revealbi.core.data.RVSqlBasedDataSource
Host name or IP address to connect to.
setHttpPath(String) - Method in class io.revealbi.core.data.RVDatabricksDataSource
Sets the partial URL corresponding to the server to connect to.
setId(String) - Method in class io.revealbi.core.data.RVDashboardDataSource
The ID of the data source.
setId(String) - Method in class io.revealbi.core.data.RVDataSourceItem
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.
setId(String) - Method in class io.revealbi.core.RVDashboardFilter
The ID of the filter.
setId(String) - Method in class io.revealbi.core.RVDateDashboardFilter
The ID of the filter.
setId(String) - Method in class io.revealbi.core.VisualizationExport
Visualization's id
setIdentifier(String) - Method in class io.revealbi.core.data.RVBoxDataSourceItem
Identifier of the file referenced by this item.
setIdentifier(String) - Method in class io.revealbi.core.data.RVGoogleDriveDataSourceItem
Google Drive identifier of the file referenced by this item.
setIdentifier(String) - Method in class io.revealbi.core.data.RVOneDriveDataSourceItem
Identifier of the file in OneDrive.
setIncludeFiltersSummaryPage(boolean) - Method in class io.revealbi.core.ExportOptions
Indicates whether a summary page listing the active filters is appended to the export.
setIncludeFiltersSummaryPage(boolean) - Method in interface io.revealbi.core.IExportOptions
Indicates whether a summary page listing the active filters is appended to the export.
setIndex(String) - Method in class io.revealbi.core.data.RVElasticsearchDataSourceItem
The name of the Elasticsearch index to query.
setInitScript(String) - Method in class io.revealbi.core.DocumentExportOptions
Indicates a script used to initialize revealView when exporting.
setInitScript(String) - Method in interface io.revealbi.core.IInitScriptProviderExportOptions
Indicates a script used to initialize revealView when exporting.
setInitScript(String) - Method in class io.revealbi.core.ImageExportOptions
Indicates a script used to initialize revealView when exporting.
setIsFolder(boolean) - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Is this single item a folder?.
setIsLandscape(boolean) - Method in class io.revealbi.core.DocumentExportOptions
Indicates page orientation when exporting
setIsLandscape(boolean) - Method in interface io.revealbi.core.IDocumentExportOptions
Indicates page orientation when exporting
setIsLibrary(boolean) - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
Is this list a document library?.
setKeepAliveSeconds(Integer) - Method in class io.revealbi.core.RVRedisOptions
Sets the keep-alive interval in seconds.
setLabel(String) - Method in class io.revealbi.core.data.RVDataModelField
Sets the label (display name) for the field.
setLabel(String) - Method in class io.revealbi.core.data.RVSchemaColumn
Sets the display label for the column shown in Reveal.
setLegacyCacheEnabled(Boolean) - Method in class io.revealbi.core.RevealSettings
setLicense(String) - Method in class io.revealbi.core.RevealSettings
License key to unlock Reveal BI Embedded and get rid of the Trial mode.
setListItemId(String) - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Identification of the single item in the list.
setListItemUrl(String) - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
URL to the single item.
setListName(String) - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
The title of the list (not the GUID!).
setListName(String) - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
Name of the list.
setListUrl(String) - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
URL to the list.
setLocalFilesStoragePath(String) - Method in class io.revealbi.core.RevealSettings
When replacing data sources (using IRVDataSourceProvider you can use local files, this property specifies the root directory to be used for URI's like "local:/Sales.xlsx" which is actually a relative location.
setLogo(byte[]) - Method in class io.revealbi.core.DocumentExportOptions
Company logo displayed in the lower left corner.
setLogo(byte[]) - Method in class io.revealbi.core.ExcelExportOptions
Deprecated.
Deprecated: This property is no longer used in excel exports and will be removed in future versions.
setLogo(byte[]) - Method in interface io.revealbi.core.IDocumentExportOptions
Company logo displayed in the lower left corner.
setMaxCacheAge(Duration) - Method in class io.revealbi.core.ExportOptions
Maximum age of cached data used during the export.
setMaxCacheAge(Duration) - Method in interface io.revealbi.core.IExportOptions
Maximum age of cached data used during the export.
setMaxCells(int) - Method in class io.revealbi.core.ExportOptions
Max cells returned when getting dashboard data
setMaxCells(int) - Method in interface io.revealbi.core.IExportOptions
Max cells returned when getting dashboard data
setMaxConcurrentExportingThreads(Integer) - Method in class io.revealbi.core.ExportConfiguration
Max allowed concurrent Threads for the exporting to image tool (Playwright).
setMaxDownloadSize(Long) - Method in class io.revealbi.core.RevealSettings
Sets a limit on the size of a single download (e.g.
setMaxFilterSize(Integer) - Method in class io.revealbi.core.RevealSettings
setMaxInMemoryCells(Long) - Method in class io.revealbi.core.RevealSettings
setMaxStorageCells(Long) - Method in class io.revealbi.core.RevealSettings
setMaxStringCellSize(Integer) - Method in class io.revealbi.core.RevealSettings
setMaxTotalStringsSize(Long) - Method in class io.revealbi.core.RevealSettings
setMethod(String) - Method in class io.revealbi.core.data.RVRESTDataSource
HTTP method to use, it defaults to GET.
setName(String) - Method in class io.revealbi.core.data.RVSchemaColumn
Sets the desired field name.
setNamedRange(String) - Method in class io.revealbi.core.data.RVExcelDataSourceItem
Named range to get data from, it's optional and if no specified the sheet specified in RVExcelDataSourceItem.getSheet() will be used.
setNeutralColor(int) - Method in class io.revealbi.core.DefaultDashboardTheme
Sets the neutral color.
setNodes(List<String>) - Method in class io.revealbi.core.data.RVElasticsearchDataSource
Gets or sets the list of Elasticsearch node endpoints to connect to in the cluster.
setObjectFilter(IRVObjectFilter) - Method in class io.revealbi.core.RevealServerBuilder
The optional object filter, used to filter 'objects' (DataSource and DataSourceItems) to be returned to the client.
setOrganization(String) - Method in class io.revealbi.core.data.RVDynamicsCrmDataSourceItem
Name of the organization to use.
setOutputLocation(String) - Method in class io.revealbi.core.data.RVAthenaDataSource
s3 path where the results will be stored.
setParameters(HashMap<String, Object>) - Method in class io.revealbi.core.data.RVInMemoryDataSourceItem
Parameters for the in-memory data source.
setParameters(HashMap<String, Object>) - Method in class io.revealbi.core.data.RVReportingServicesDataSourceItem
Sets the report parameters to pass to the Reporting Services report.
setParameters(HashMap<String, Object>) - Method in class io.revealbi.core.data.RVRESTDataSourceItem
Values for the parameters specified in the data source RVRESTDataSource.getUrl() property.
setPassword(String) - Method in class io.revealbi.core.RVRedisOptions
Sets the password for Redis authentication.
setPath(String) - Method in class io.revealbi.core.data.RVClickHouseDataSource
(Optional) The URL path appended after the host and port.
setPath(String) - Method in class io.revealbi.core.data.RVDropboxDataSourceItem
Path to the file in Dropbox account.
setPath(String) - Method in class io.revealbi.core.data.RVReportingServicesDataSource
Path in the server, used only when SSRS is running integrated into SharePoint
setPath(String) - Method in class io.revealbi.core.data.RVReportingServicesDataSourceItem
Path to the report.
setPath(String) - Method in class io.revealbi.core.data.RVS3DataSourceItem
S3 path for the file represented by this item.
setPivotTable(String) - Method in class io.revealbi.core.data.RVExcelDataSourceItem
Sets the name of the pivot table to get data from within the Excel file.
setPort(int) - Method in class io.revealbi.core.data.RVNativeAnalysisServicesDataSource
TCP port where the server is accepting connections, 2383 is the default port for SSAS.
setPort(int) - Method in class io.revealbi.core.data.RVSqlBasedDataSource
TCP Port to connect to.
setPoweredBy(String) - Method in class io.revealbi.core.DocumentExportOptions
setPoweredBy(String) - Method in class io.revealbi.core.ExcelExportOptions
Deprecated.
Deprecated: This property is no longer used in excel exports and will be removed in future versions.
setProcedure(String) - Method in class io.revealbi.core.data.RVMySqlDataSourceItem
(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.
setProcedure(String) - Method in class io.revealbi.core.data.RVSnowflakeDataSourceItem
(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.
setProcedure(String) - Method in class io.revealbi.core.data.RVSqlServerDataSourceItem
(Optional) name of the stored procedure to get data from, the procedure is expected to return a result set and might have multiple parameters.
setProcedureParameters(HashMap) - Method in class io.revealbi.core.data.RVMySqlDataSourceItem
Parameters to be passed to the stored procedure, if there is such specified in RVMySqlDataSourceItem.getProcedure().
setProcedureParameters(HashMap) - Method in class io.revealbi.core.data.RVSnowflakeDataSourceItem
Parameters to be passed to the stored procedure, if there is such specified in RVSnowflakeDataSourceItem.getProcedure().
setProcedureParameters(HashMap<String, Object>) - Method in class io.revealbi.core.data.RVSqlServerDataSourceItem
Parameters to be passed to the stored procedure, if there is such specified in RVSqlServerDataSourceItem.getProcedure().
setProcessDataOnServer(boolean) - Method in interface io.revealbi.core.data.IProcessDataOnServerDataSourceItem
Configures if the "Process Data on Server" option is turned on for this item (table or view).
setProcessDataOnServer(boolean) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSourceItem
Sets whether data processing is performed on the Reveal server.
setProcessDataOnServer(boolean) - Method in class io.revealbi.core.data.RVElasticsearchDataSourceItem
Sets whether data processing is performed on the Reveal server.
setProcessDataOnServer(boolean) - Method in class io.revealbi.core.data.RVMongoDBDataSourceItem
Sets whether data processing is performed on the Reveal server.
setProcessDataOnServer(boolean) - Method in class io.revealbi.core.data.RVSqlPDSDataSourceItem
Configures if the "Process Data on Server" option is turned on for this item (table or view), defaults to true.
setProcessDataOnServerDefaultValue(boolean) - Method in interface io.revealbi.core.data.IProcessDataOnServerDataSource
Sets the default value for "Process Data on Server" option for this data source.
setProcessDataOnServerDefaultValue(boolean) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
Sets the default value for "Process Data on Server" option for this data source.
setProcessDataOnServerDefaultValue(boolean) - Method in class io.revealbi.core.data.RVElasticsearchDataSource
Sets the default value for "Process Data on Server" option for this data source.
setProcessDataOnServerDefaultValue(boolean) - Method in class io.revealbi.core.data.RVMongoDBDataSource
Sets the default value for the "Process Data on Server" option for this data source.
setProcessDataOnServerDefaultValue(boolean) - Method in class io.revealbi.core.data.RVSqlPDSDataSource
Sets the default value for "Process Data on Server" option for this data source, the end user can still change the value, unless RVSqlPDSDataSource.setProcessDataOnServerReadOnly(boolean) is true.
setProcessDataOnServerReadOnly(boolean) - Method in interface io.revealbi.core.data.IProcessDataOnServerDataSource
Sets whether the user is allowed to change the value for "Process Data on Server" option.
setProcessDataOnServerReadOnly(boolean) - Method in class io.revealbi.core.data.RVAzureCosmosDBDataSource
When set to true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
setProcessDataOnServerReadOnly(boolean) - Method in class io.revealbi.core.data.RVElasticsearchDataSource
When set to true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
setProcessDataOnServerReadOnly(boolean) - Method in class io.revealbi.core.data.RVMongoDBDataSource
When true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
setProcessDataOnServerReadOnly(boolean) - Method in class io.revealbi.core.data.RVSqlPDSDataSource
When set to true the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.
setProjectId(String) - Method in class io.revealbi.core.data.RVBigQueryDataSource
BigQuery ProjectId.
setProjectId(String) - Method in class io.revealbi.core.data.RVBigQueryDataSourceItem
BigQuery ProjectId.
setPropertyId(String) - Method in class io.revealbi.core.data.RVGoogleAnalytics4DataSourceItem
Property identifier to get data from.
setProtocol(String) - Method in class io.revealbi.core.data.RVClickHouseDataSource
(Optional) The protocol used to connect to ClickHouse (e.g.
setRange(RVExcelRange) - Method in class io.revealbi.core.data.RVExcelDataSourceItem
Definition of the range to load data from in the specified sheet.
setRange(RVDateRange) - Method in class io.revealbi.core.RVDateDashboardFilter
The date range used for filtering.
setRealmId(String) - Method in class io.revealbi.core.data.RVQuickBooksDataSource
Realm Id, the unique ID identifying a specific QuickBooks company.
setReconnectRetryPolicy(String) - Method in class io.revealbi.core.RVRedisOptions
Sets the reconnection retry policy.
setRedisOptions(RVRedisOptions) - Method in class io.revealbi.core.RevealSettings
Sets the Redis cache options.
setRegion(String) - Method in class io.revealbi.core.data.RVAthenaDataSource
Region for the service.
setRegion(String) - Method in class io.revealbi.core.data.RVS3DataSource
Region for the service.
setRenderMode(RVReportingServicesRenderMode) - Method in class io.revealbi.core.data.RVReportingServicesDataSourceItem
Render mode, might be data or report.
setResourceItem(IRVResourceItem) - Method in class io.revealbi.core.data.RVResourceBasedDataSourceItem
The resource item used to get the data for the referenced file, must be an item from one of the resource providers: Sharepoint, Web Resource, REST API, etc.
setRetryDelayMs(Integer) - Method in class io.revealbi.core.RVRedisOptions
Sets the base delay in milliseconds used by the retry policy.
setRole(String) - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the role that will be used to access Snowflake.
setRule(RVDateRule) - Method in class io.revealbi.core.RVDateDashboardFilter
The date rule used for filtering.
setSchema(String) - Method in class io.revealbi.core.data.RVDatabricksDataSource
Sets the name of the schema to connect to.
setSchema(String) - Method in class io.revealbi.core.data.RVDatabricksDataSourceItem
Sets the name of the schema to connect to.
setSchema(String) - Method in class io.revealbi.core.data.RVPostgresDataSource
Name of the schema to use.
setSchema(String) - Method in class io.revealbi.core.data.RVPostgresDataSourceItem
Name of the schema the referenced table belongs to.
setSchema(String) - Method in class io.revealbi.core.data.RVRedshiftDataSource
Name of the schema to use.
setSchema(String) - Method in class io.revealbi.core.data.RVRedshiftDataSourceItem
Name of the schema the referenced table belongs to.
setSchema(String) - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the schema the referenced table belongs to.
setSchema(String) - Method in class io.revealbi.core.data.RVSnowflakeDataSourceItem
Name of the schema the referenced table belongs to.
setSchema(String) - Method in class io.revealbi.core.data.RVSqlServerDataSource
Name of the schema to use to filter tables, views and store procedures, by default all schemas are displayed.
setSchema(String) - Method in class io.revealbi.core.data.RVSqlServerDataSourceItem
Name of the schema the referenced table belongs to.
setSchema(String) - Method in class io.revealbi.core.data.RVSyBaseDataSourceItem
Name of the schema the referenced table belongs to.
setSdkJsDistributionFile(String) - Method in class io.revealbi.core.ExportConfiguration
Indicates a local zip file containing the sdk js distribution.
setSeparator(String) - Method in class io.revealbi.core.data.RVCsvDataSourceItem
The separator to use, one of ',', ';', or 'TAB'.
setSeriesColor(int[]) - Method in class io.revealbi.core.DefaultDashboardTheme
Sets the series colors.
setServerMode(String) - Method in class io.revealbi.core.data.RVReportingServicesDataSource
Sets the server mode for Reporting Services.
setServerUrl(String) - Method in class io.revealbi.core.data.RVAzureAnalysisServicesDataSource
Server Url, including the 'asazure://' prefix (scheme).
setServerVersion(String) - Method in class io.revealbi.core.data.RVReportingServicesDataSource
Sets the Reporting Services server version.
setService(String) - Method in class io.revealbi.core.data.RVOracleServiceDataSource
Service name to use when connecting to Oracle server.
setSheet(String) - Method in class io.revealbi.core.data.RVExcelDataSourceItem
Name of the sheet in the worksheet to get the data from, if not specified and RVExcelDataSourceItem.getNamedRange() is null, then the first sheet in the file will be used.
setShowTitle(boolean) - Method in class io.revealbi.core.VisualizationExport
Indicates whether the visualization title will be displayed on the captured image.
setSID(String) - Method in class io.revealbi.core.data.RVOracleSIDDataSource
SID to use when connecting to Oracle server.
setSiteUrl(String) - Method in class io.revealbi.core.data.RVGoogleSearchConsoleDataSourceItem
The URL of the property as defined in Search Console
setSkipServerCertificateValidation(Boolean) - Method in class io.revealbi.core.data.RVClickHouseDataSource
(Optional) When true, skips server certificate validation for TLS connections.
setStartDate(Calendar) - Method in class io.revealbi.core.data.RVHubspotDataSourceItem
Start date to use when requesting data.
setStartDate(Calendar) - Method in class io.revealbi.core.data.RVMarketoDataSourceItem
Start date to use when requesting data.
setStatus(int) - Method in interface io.revealbi.core.impl.IHttpResponse
 
setSubtitle(String) - Method in class io.revealbi.core.data.RVDashboardDataSource
The subtitle of the data source as displayed to users.
setSubtitle(String) - Method in class io.revealbi.core.data.RVDataSourceItem
The subtitle of the data source as displayed to users.
setSyncTimeoutMs(Integer) - Method in class io.revealbi.core.RVRedisOptions
Sets the synchronous operation timeout in milliseconds.
setSystemUserContextProvider(IRVSystemUserContextProvider) - Method in class io.revealbi.core.RevealServerBuilder
Sets a provider for system-level engine callbacks that are not associated with a normal client request.
setTable(String) - Method in class io.revealbi.core.data.RVAthenaDataSourceItem
Table or view for this data source item.
setTable(String) - Method in class io.revealbi.core.data.RVBigQueryDataSourceItem
Name of the table (or view) to get data from.
setTable(String) - Method in class io.revealbi.core.data.RVSqlBasedDataSourceItem
Name of the table (or view) to get data from.
setTheme(IDashboardTheme) - Method in class io.revealbi.core.ExportOptions
Theme object to indicate export used colors
setTheme(IDashboardTheme) - Method in interface io.revealbi.core.IExportOptions
Theme object to indicate export used colors
setTimeout(int) - Method in class io.revealbi.core.ExportOptions
Timeout in seconds for exporting a dashboard
setTimeout(int) - Method in interface io.revealbi.core.IExportOptions
Timeout in seconds for exporting a dashboard
setTimeout(Integer) - Method in class io.revealbi.core.data.RVClickHouseDataSource
(Optional) Connection timeout in seconds.
setTimeZone(String) - Method in class io.revealbi.core.ExportOptions
Timezone in IANA format
setTimeZone(String) - Method in interface io.revealbi.core.IExportOptions
Timezone in IANA format
setTitle(String) - Method in class io.revealbi.core.data.RVDashboardDataSource
The title of the data source as displayed to users.
setTitle(String) - Method in class io.revealbi.core.data.RVDataSourceItem
The title of the item, as displayed to the user, it might be for example the name of the table in a database.
setTitle(String) - Method in class io.revealbi.core.RVDashboardFilter
The title of the filter.
setTitle(String) - Method in class io.revealbi.core.RVDateDashboardFilter
The title of the filter.
setTitle(String) - Method in class io.revealbi.core.VisualizationExport
Visualization's title
setTrustServerCertificate(Boolean) - Method in class io.revealbi.core.data.RVSqlServerDataSource
If not null, the TrustServerCertificate flag will be set in the connection string to the specified value.
setType(RVDashboardDataType) - Method in class io.revealbi.core.data.RVDataModelField
Sets the data type of the field.
setType(RVSchemaColumnType) - Method in class io.revealbi.core.data.RVSchemaColumn
Sets the desired data type.
setUri(String) - Method in class io.revealbi.core.data.RVLocalFileDataSourceItem
The URI referencing the file, like local://Directory/File.csv.
setUrl(String) - Method in class io.revealbi.core.data.RVDynamicsCrmDataSource
Dynamics CRM base URL.
setUrl(String) - Method in class io.revealbi.core.data.RVHttpAnalysisServicesDataSource
URL to the msmdpump endpoint, for example: http://server/olap/msmdpump.dll
setUrl(String) - Method in class io.revealbi.core.data.RVMarketoDataSource
URL to the login endpoint.
setUrl(String) - Method in class io.revealbi.core.data.RVMarketoDataSourceItem
URL to the Marketo endpoint, must match the URL specified in the RVMarketoDataSource data source object.
setUrl(String) - Method in class io.revealbi.core.data.RVODataDataSource
URL to the OData endpoint, is expected to be a URL with HTTP or HTTPS scheme.
setUrl(String) - Method in class io.revealbi.core.data.RVODataDataSourceItem
URL to the OData entity set or function.
setUrl(String) - Method in class io.revealbi.core.data.RVReportingServicesDataSource
URL to the server
setUrl(String) - Method in class io.revealbi.core.data.RVRESTDataSource
URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme.
setUrl(String) - Method in class io.revealbi.core.data.RVRESTDataSourceItem
Deprecated.
This property is deprecated and will soon be removed. Please set the Url directly on the data source instead.
setUrl(String) - Method in class io.revealbi.core.data.RVSharePointDataSource
URL to the Sharepoint site (or sub site) to use.
setUrl(String) - Method in class io.revealbi.core.data.RVWebResourceDataSource
URL to the web resource, is expected to be a URL with HTTP or HTTPS scheme.
setUrl(String) - Method in class io.revealbi.core.data.RVWebResourceDataSourceItem
URL to use to download the file, must match the URL specified in the RVWebResourceDataSource data source object.
setUseAnonymousAuthentication(boolean) - Method in class io.revealbi.core.data.RVODataDataSource
Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.
setUseAnonymousAuthentication(boolean) - Method in class io.revealbi.core.data.RVRESTDataSource
Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.
setUseAnonymousAuthentication(boolean) - Method in class io.revealbi.core.data.RVWebResourceDataSource
Boolean flag indicating if anonymous authentication should be used for this data source or credentials must be requested to the containing application.
setUseFormattedValues(boolean) - Method in class io.revealbi.core.CsvExportOptions
Indicates whether to use formatted values for CSV export.
setUseFormattedValues(boolean) - Method in interface io.revealbi.core.ICsvExportOptions
Sets whether formatted values are used instead of raw data values.
setUseNewCharts(boolean) - Method in class io.revealbi.core.ExportOptions
 
setUseNewCharts(boolean) - Method in interface io.revealbi.core.IExportOptions
 
setUsePreemptiveAuthentication(boolean) - Method in class io.revealbi.core.data.RVODataDataSource
Boolean flag indicating if preemptive authentication should be used for this data source to the containing application.
setUsePreemptiveAuthentication(boolean) - Method in class io.revealbi.core.data.RVRESTDataSource
Boolean flag indicating if preemptive authentication should be used for this data source to the containing application.
setUser(String) - Method in class io.revealbi.core.RVRedisOptions
Sets the username for Redis authentication.
setUserId(String) - Method in class io.revealbi.core.data.RVSharePointPeopleDataSourceItem
Optional user id when a single user should be displayed.
setUserLanguage(String) - Method in class io.revealbi.core.ExportOptions
User language
setUserLanguage(String) - Method in interface io.revealbi.core.IExportOptions
User language
setUseSsl(Boolean) - Method in class io.revealbi.core.RVRedisOptions
Sets whether SSL/TLS encryption should be used.
setValues(Iterable<Object>) - Method in class io.revealbi.core.RVDashboardFilter
Sets the filter values.
setView(String) - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
Name of the view to use.
setVisualizationMode(ExcelVisualizationMode) - Method in class io.revealbi.core.ExcelExportOptions
 
setVisualizationMode(ExcelVisualizationMode) - Method in interface io.revealbi.core.IExcelExportOptions
Indicates additional configuration for Excel, see ExcelVisualizationMode
setVisualizations(ArrayList<VisualizationExport>) - Method in class io.revealbi.core.ExportOptions
List of visualizations that will be exported.
setVisualizations(ArrayList<VisualizationExport>) - Method in interface io.revealbi.core.IExportOptions
List of visualizations that will be exported.
setWarehouse(String) - Method in class io.revealbi.core.data.RVSnowflakeDataSource
Name of the Snowflake warehouse to use in this connection.
setWebUrl(String) - Method in class io.revealbi.core.data.RVSharePointListDataSourceItem
URL to the site containing the list.
setWebUrl(String) - Method in class io.revealbi.core.data.RVSharePointListItemDataSourceItem
URL to the site containing the list.
setWebUrl(String) - Method in class io.revealbi.core.data.RVSharePointSiteDataSourceItem
URL to the site or sub site.
setWeekLevelEnabled(boolean) - Method in class io.revealbi.core.data.RVDataModelField
Sets whether week-level grouping is enabled for date fields.
setWorkgroup(String) - Method in class io.revealbi.core.data.RVAthenaDataSource
Workgroup used to run queries.
shutdown() - Method in class io.revealbi.core.impl.RevealServer
 
shutdown() - Method in interface io.revealbi.core.IRevealServer
Shuts down the Reveal server.
SITE - Enum constant in enum class io.revealbi.core.data.RVSharePointItemType
 
StDev - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 
String - Enum constant in enum class io.revealbi.core.data.RVDashboardDataType
Text data
Sum - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 

T

TEXT - Enum constant in enum class io.revealbi.core.data.RVSchemaColumnType
 
THIS - Enum constant in enum class io.revealbi.core.RVPeriodRelation
This [period] = beginning of current [period] until end of current [period]
THIS_MONTH - Enum constant in enum class io.revealbi.core.RVDateFilterType
This month, including the rest of it
THIS_QUARTER - Enum constant in enum class io.revealbi.core.RVDateFilterType
This quarter, including the rest of it
THIS_YEAR - Enum constant in enum class io.revealbi.core.RVDateFilterType
This year, including the rest of it.
Time - Enum constant in enum class io.revealbi.core.data.RVDashboardDataType
Time data
TIME - Enum constant in enum class io.revealbi.core.data.RVSchemaColumnType
 
TO_DATE - Enum constant in enum class io.revealbi.core.RVPeriodRelation
[period] to date = beginning of current [period] until today
TODAY - Enum constant in enum class io.revealbi.core.RVDateFilterType
Today
TRAILING_TWELVE_MONTHS - Enum constant in enum class io.revealbi.core.RVDateFilterType
The last 12 complete months

V

validate() - Method in class io.revealbi.core.RVRedisOptions
Validates this options instance, throwing IllegalArgumentException if neither a non-blank connectionString nor a non-empty endPoints list has been set.
valueOf(int) - Static method in enum class io.revealbi.core.data.RVAzureCosmosDBConnectionMode
Returns the RVAzureCosmosDBConnectionMode for the given integer value.
valueOf(int) - Static method in enum class io.revealbi.core.data.RVGoogleAnalyticsResourceType
Returns the RVGoogleAnalyticsResourceType for the given integer value.
valueOf(int) - Static method in enum class io.revealbi.core.data.RVReportingServicesRenderMode
Returns the RVReportingServicesRenderMode for the given integer value.
valueOf(int) - Static method in enum class io.revealbi.core.data.RVSchemaColumnType
Returns the RVSchemaColumnType for the given integer value.
valueOf(int) - Static method in enum class io.revealbi.core.data.RVSharePointAuthenticationMethod
Returns the RVSharePointAuthenticationMethod for the given integer value.
valueOf(int) - Static method in enum class io.revealbi.core.data.RVSharePointItemType
Returns the RVSharePointItemType for the given integer value.
valueOf(int) - Static method in enum class io.revealbi.core.RVDateFilterType
Returns the RVDateFilterType constant for the given integer value.
valueOf(String) - Static method in enum class io.revealbi.core.data.RVAzureCosmosDBConnectionMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.data.RVDashboardAggregationType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.data.RVDashboardDataType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.data.RVGoogleAnalyticsResourceType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.data.RVReportingServicesRenderMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.data.RVSchemaColumnType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.data.RVSharePointAuthenticationMethod
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.data.RVSharePointItemType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.ExcelVisualizationMode
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.ExportExcelVisualization
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.ExportFormat
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.RVDateFilterType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.RVPeriodRelation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.revealbi.core.RVPeriodType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.revealbi.core.data.RVAzureCosmosDBConnectionMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.data.RVDashboardAggregationType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.data.RVDashboardDataType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.data.RVGoogleAnalyticsResourceType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.data.RVReportingServicesRenderMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.data.RVSchemaColumnType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.data.RVSharePointAuthenticationMethod
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.data.RVSharePointItemType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.ExcelVisualizationMode
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.ExportExcelVisualization
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.ExportFormat
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.RVDateFilterType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.RVPeriodRelation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.revealbi.core.RVPeriodType
Returns an array containing the constants of this enum class, in the order they are declared.
Variance - Enum constant in enum class io.revealbi.core.data.RVDashboardAggregationType
 
VisualizationExport - Class in io.revealbi.core
Object used to indicate which visualizations will be exported
VisualizationExport() - Constructor for class io.revealbi.core.VisualizationExport
Creates a new VisualizationExport with no ID or title set.
VisualizationExport(String) - Constructor for class io.revealbi.core.VisualizationExport
Creates a new VisualizationExport for the visualization with the given ID.
visualizationMode - Variable in class io.revealbi.core.ExcelExportOptions
Controls how visualizations are included in the Excel export.

W

WEB_LOGIN - Enum constant in enum class io.revealbi.core.data.RVSharePointAuthenticationMethod
 
WEEK - Enum constant in enum class io.revealbi.core.RVPeriodType
Week (starting on Monday)
WINDOWS - Enum constant in enum class io.revealbi.core.data.RVSharePointAuthenticationMethod
 

Y

YEAR - Enum constant in enum class io.revealbi.core.RVPeriodType
Year
YEAR_TO_DATE - Enum constant in enum class io.revealbi.core.RVDateFilterType
From Jan 1st this year to today
YESTERDAY - Enum constant in enum class io.revealbi.core.RVDateFilterType
Yesterday
A B C D E F G I L M N O P Q R S T V W Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form