Package io.revealbi.core

Class RevealSettings

java.lang.Object
io.revealbi.core.RevealSettings
public class RevealSettings extends Object
Contains Reveal server settings.

  • Constructor Details

    • RevealSettings

      public RevealSettings()

  • Method Details

    • getAdvancedSetting

      public Object getAdvancedSetting(String name)
      Returns the value of the specified advanced setting.
      Parameters:
      name - The advanced setting name.
      Returns:
      The value of the specified advanced setting.

    • setAdvancedSetting

      public void setAdvancedSetting(String name, Object value)
      Sets an advanced setting value.
      Parameters:
      name - The advanced setting name.
      value - The advanced setting value.

    • getAdvancedSettings

      public Map<String,Object> getAdvancedSettings()
      Returns all advanced settings.
      Returns:
      All advanced settings.

    • getLicense

      public String getLicense()
      See setLicense(String).

    • setLicense

      public void setLicense(String license)
      License key to unlock Reveal BI Embedded and get rid of the Trial mode.

    • getLocalFilesStoragePath

      public String getLocalFilesStoragePath()
      See setLocalFilesStoragePath(String).

    • setLocalFilesStoragePath

      public void setLocalFilesStoragePath(String path)
      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.

    • getMaxDownloadSize

      public Long getMaxDownloadSize()
      See setMaxDownloadSize(Long).

    • setMaxDownloadSize

      public void setMaxDownloadSize(Long v)
      Sets a limit on the size of a single download (e.g. a CSV file). Default is 200Mb.

    • getMaxInMemoryCells

      public Long getMaxInMemoryCells()
      Expected maximum size of pivot tables or grids, as a number of in-memory cells. The engine avoids using too much memory and this setting provides a hint for its memory management. If unset, the engine defaults to 10,000,000 cells.

    • setMaxInMemoryCells

      public void setMaxInMemoryCells(Long v)
      See getMaxInMemoryCells().

    • getMaxStorageCells

      public Long getMaxStorageCells()
      Expected maximum number of cells to be processed from any data source (e.g., SQL Server rows, CSV rows). The engine avoids using too much disk space for its cache and this setting provides a hint for its caching management. If unset, the engine defaults to 10,000,000 cells.

    • setMaxStorageCells

      public void setMaxStorageCells(Long v)
      See getMaxStorageCells().

    • getMaxTotalStringsSize

      public Long getMaxTotalStringsSize()
      Expected maximum size of pivot tables or grids given as the total number of characters across all cells in a dataset. The engine avoids using too much memory and this setting provides a hint for its memory management. If unset, the engine defaults to 64,000,000 characters.

    • setMaxTotalStringsSize

      public void setMaxTotalStringsSize(Long v)
      See getMaxTotalStringsSize().

    • getMaxStringCellSize

      public Integer getMaxStringCellSize()
      Limit on the number of characters any single string cell may have in a dataset column. If unset, the engine defaults to 256 characters.

    • setMaxStringCellSize

      public void setMaxStringCellSize(Integer v)
      See getMaxStringCellSize().

    • getCachePath

      public String getCachePath()
      Directory where cache-related files (e.g., downloaded artifacts) are stored. Defaults to the system temporary directory if unset.

    • setCachePath

      public void setCachePath(String path)
      See getCachePath().

    • getMaxFilterSize

      public Integer getMaxFilterSize()
      Maximum number of elements allowed for filters. Defaults to 3,000 if unset.

    • setMaxFilterSize

      public void setMaxFilterSize(Integer v)
      See getMaxFilterSize().

    • isLegacyCacheEnabled

      public Boolean isLegacyCacheEnabled()
      Uses the legacy SQLite cache. Defaults to true if unset.

    • setLegacyCacheEnabled

      public void setLegacyCacheEnabled(Boolean b)
      See isLegacyCacheEnabled()

    • isCacheEncryptionEnabled

      public Boolean isCacheEncryptionEnabled()
      Enables the use of encryption of the SQLite cache (only works for the newer SQLite cache). Defaults to false if unset.

    • setCacheEncryptionEnabled

      public void setCacheEncryptionEnabled(Boolean b)
      See isCacheEncryptionEnabled()

    • getCacheEncryptionPassword

      public String getCacheEncryptionPassword()
      Sets the encryption password for the SQLite cache files (ignored if encryption is disabled)

    • setCacheEncryptionPassword

      public void setCacheEncryptionPassword(String b)
      See getCacheEncryptionPassword()

    • getRedisOptions

      public RVRedisOptions getRedisOptions()
      Gets the Redis cache options. When set, Reveal will use Redis instead of the in-memory cache.

    • setRedisOptions

      public void setRedisOptions(RVRedisOptions redisOptions)
      Sets the Redis cache options. When set, Reveal will use Redis instead of the in-memory cache. Use RVRedisOptions to configure the Redis connection (endpoint, credentials, timeouts, etc.).

    • getExportConfiguration

      public ExportConfiguration getExportConfiguration()
      Returns the export configuration.
      Returns:
      The export configuration.

    • getPlugins

      public List<RevealPlugin> getPlugins()

    • addPlugin

      public void addPlugin(RevealPlugin plugin)