Package com.appliedolap.essbase

Class EssWorkbookImportOptions

java.lang.Object
com.appliedolap.essbase.EssWorkbookImportOptions
public final class EssWorkbookImportOptions extends Object
What an application workbook import should actually do.

An application workbook is not only an outline. Oracle's own Sample_Basic.xlsx carries the cube definition, a sheet per dimension, 4,256 rows of data, a calculation script and a sample query - and the import reads as much or as little of that as it is told to. The job reports back exactly four flags it acted on: load data, recreate application, create files, execute script.

The defaults load the data and run the scripts, because a workbook that carries both almost certainly means them to be used: an import that skips them leaves a cube whose every upper level reads #Missing, which looks like a failed import rather than a partial one.

  • Constructor Details

    • EssWorkbookImportOptions

      public EssWorkbookImportOptions()

  • Method Details

    • defaults

      public static EssWorkbookImportOptions defaults()
      Loads the data and runs the scripts; does not recreate an existing application.

    • loadData

      public EssWorkbookImportOptions loadData(boolean loadData)
      Whether to load the workbook's data sheets.

    • executeScripts

      public EssWorkbookImportOptions executeScripts(boolean executeScripts)
      Whether to run the calculation scripts the workbook carries.

      This is what makes the difference between a cube with data in it and a cube you can query: loading writes level 0 and aggregates nothing.

    • createFiles

      public EssWorkbookImportOptions createFiles(boolean createFiles)
      Whether to create the scripts, rules and queries the workbook defines.

    • recreateApplication

      public EssWorkbookImportOptions recreateApplication(boolean recreateApplication)
      Whether to destroy an existing application of this name and build it again.

      Off by default, and the only genuinely destructive thing here: it discards the application and everything in it, not just what the workbook describes.

    • overwrite

      public EssWorkbookImportOptions overwrite(boolean overwrite)
      Whether the import may overwrite artifacts it finds already present.

    • deleteWorkbookOnSuccess

      public EssWorkbookImportOptions deleteWorkbookOnSuccess(boolean deleteWorkbookOnSuccess)
      Whether to delete the workbook from the catalogue once the import succeeds.

    • isLoadData

      public boolean isLoadData()

    • isExecuteScripts

      public boolean isExecuteScripts()

    • isCreateFiles

      public boolean isCreateFiles()

    • isRecreateApplication

      public boolean isRecreateApplication()

    • isOverwrite

      public boolean isOverwrite()

    • isDeleteWorkbookOnSuccess

      public boolean isDeleteWorkbookOnSuccess()