Package com.infragistics.reveal.engine.init

Class InitializeParameterBuilder

    • Method Detail

      • setUserContextProvider

        public InitializeParameterBuilder setUserContextProvider​(IRVUserContextProvider userContextProvider)
        The user context provider that provides the ID of the current user (if any) for a given request.
        Parameters:
        userContextProvider - An instance of IRVUserContextProvider used to provide the user ID for a given request.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setDashboardProvider

        public InitializeParameterBuilder setDashboardProvider​(IRVDashboardProvider dashboardProvider)
        The dashboard provider, used to load and save dashboards.
        Parameters:
        dashboardProvider - An instance of IRVDashboardProvider used to load and save dashboards.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setDataSourceProvider

        public InitializeParameterBuilder setDataSourceProvider​(IRVDataSourceProvider dataSourceProvider)
        The data source provider, used to replace data sources in existing dashboards when they are opened.
        Parameters:
        dataSourceProvider - An instance of IRVDataSourceProvider used to replace data sources in existing dashboards.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setDataProvider

        public InitializeParameterBuilder setDataProvider​(IRVDataProvider dataProvider)
        The data provider, used for in-memory data sources.
        Parameters:
        dataProvider - An instance of IRVDataProvider used for in-memory data sources.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setObjectEncoder

        public InitializeParameterBuilder setObjectEncoder​(IRVObjectEncoder objectEncoder)
        The optional object encoder, used to encode information in DataSource or DataSourceItems, before returning those objects to the client.
        Parameters:
        objectEncoder - The object encoder instance.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setObjectFilter

        public InitializeParameterBuilder setObjectFilter​(IRVObjectFilter objectFilter)
        The optional object filter, used to filter 'objects' (DataSource and DataSourceItems) to be returned to the client.
        Parameters:
        objectFilter - The object filter instance.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setRestUrlResolver

        public InitializeParameterBuilder setRestUrlResolver​(IRVRestUrlResolver restUrlResolver)
        The optional REST URL Resolver that can be used to resolve the URL to use when using REST data sources from the original URL defined in the data source and the list of parameters entered by the user.
        Parameters:
        restUrlResolver -
        Returns:

      • setMaxConcurrentImageRenderThreads

        public InitializeParameterBuilder setMaxConcurrentImageRenderThreads​(int value)
        Used to limit the number of threads used to export images when a dashboard is exported, this controls the size of a pool thread used for that purpose.
        Parameters:
        value - The number of concurrent threads used to export dashboards or visualizations to images.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setExportToolContainerPath

        public InitializeParameterBuilder setExportToolContainerPath​(String value)
        Path containing the ExportTool binary, needed only if the automatic download of this tool is not working fine.
        Parameters:
        value - The path containing the ExportTool binary, you can get more information here.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setLicense

        public InitializeParameterBuilder setLicense​(String license)
        License key to unlock Reveal BI Embedded and get rid of the Trial mode
        Parameters:
        license - The license key to use.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setExportToolEnableDownload

        public InitializeParameterBuilder setExportToolEnableDownload​(boolean value)
        By default the "ExportTool" is downloaded automatically when this component is used by the first time, this flag can be used to turn off that behavior.
        Parameters:
        value - If the "ExportTool" should be downloaded automatically or not, defaults to true.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setLocalFilesStoragePath

        public InitializeParameterBuilder 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.
        Parameters:
        path - The root directory to be used for local data files
        Returns:
        The same build instance, so you can continue setting other properties.

      • setMaxInMemoryCells

        public InitializeParameterBuilder setMaxInMemoryCells​(Long v)
        Set this property to the expected maximum size of pivot tables or grids, given as a number of cells. The engine avoids using too much memory and this setting provides a hint for its memory management.
        Parameters:
        v - Max number of in memory cells. Default is 10 million cells.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setMaxStorageCells

        public InitializeParameterBuilder setMaxStorageCells​(Long v)
        Set this property to the expected maximum size of cells to be processed from any data source (e.g. from a Sql Server table rows, from CSV rows, etc.). The engine avoids using too much disk space for its cache and this setting provides a hint for its caching management.
        Parameters:
        v - Max number of cells to be stored in disk. Default is 10 million cells.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setMaxTotalStringsSize

        public InitializeParameterBuilder setMaxTotalStringsSize​(Long v)
        Set this property to the expected maximum size of pivot tables or grids, given as the total number of characters in all of its cells. The engine avoids using too much memory and this setting provides a hint for its memory management.
        Parameters:
        v - Max total number of characters to hold in memory for a dataset. Default is 64 million.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setMaxStringCellSize

        public InitializeParameterBuilder setMaxStringCellSize​(Integer v)
        Sets a limit on the number of characters any string in a dataset column may have.
        Parameters:
        v - Max size of string for a cell. Default is 256.
        Returns:
        The same build instance, so you can continue setting other properties.

      • setChromiumExecutablePath

        public InitializeParameterBuilder setChromiumExecutablePath​(String path)
        Sets the path to Chromium executable file. If not set, the application will use a temporary folder to download chromium and use it from there.
        Parameters:
        path - Absolute path to chrome.exe
        Returns:
        The same build instance, so you can continue setting other properties.

      • setChromiumDownloadFolder

        public InitializeParameterBuilder setChromiumDownloadFolder​(String path)
        Indicates the folder where Chromium will be downloaded. The intention of this property is to allow the application to download Chromium automatically
        Parameters:
        path - Path pointing the the folder where Chromium will be downloaded
        Returns:
        The same build instance, so you can continue setting other properties.

      • setSdkJsDistributionFile

        public InitializeParameterBuilder setSdkJsDistributionFile​(String path)
        Indicates a local zip file containing the sdk js distribution. It could be downloaded from https://maven.revealbi.io/repository/public/com/infragistics/reveal/sdk/reveal-sdk-distribution/x.x.x/reveal-sdk-distribution-x.x.x-js.zip, where x.x.x is the corresponding version.
        Parameters:
        path - Local path to the sdk js distribution zip
        Returns:
        The same build instance, so you can continue setting other properties.