Class ClassicEngineBoot

  • All Implemented Interfaces:

    public class ClassicEngineBoot
    extends org.pentaho.reporting.libraries.base.boot.AbstractBoot
    An utility class to safely boot and initialize the Pentaho-Reporting library. This class should be called before using the Pentaho-Reporting classes, to make sure that all subsystems are initialized correctly and in the correct order.

    Application developers should make sure, that the booting is done before any Pentaho-Reporting functions are used. If the system has not be initialized by booting this class, anything can happen and the results of all functionality of this reporting engine will be undefined.

    Additional modules can be specified by defining the system property "org.pentaho.reporting.engine.classic .core.boot.Modules". The property expects a comma-separated list of Module implementations.

    Booting should be done by aquirering a new boot instance using getInstance() and then starting the boot process with AbstractBoot.start().

    Thomas Morgner
    • Field Detail


        public static final int VERSION_TRUNK
      • VERSION_3_8

        public static final int VERSION_3_8
      • VERSION_3_9

        public static final int VERSION_3_9
      • VERSION_4_0

        public static final int VERSION_4_0
    • Method Detail

      • getInstance

        public static ClassicEngineBoot getInstance()
        Returns the singleton instance of the boot utility class.
        the boot instance.
      • getEditableConfig

        public org.pentaho.reporting.libraries.base.config.ModifiableConfiguration getEditableConfig()
        Returns the current global configuration as modifiable instance. This is exactly the same as casting the global configuration into a ModifableConfiguration instance.

        This is a convinience function, as all programmers are lazy.

        the global config as modifiable configuration.
      • getProjectInfo

        protected org.pentaho.reporting.libraries.base.versioning.ProjectInformation getProjectInfo()
        Returns the project info.
        Specified by:
        getProjectInfo in class org.pentaho.reporting.libraries.base.boot.AbstractBoot
        The project info.
      • loadConfiguration

        protected org.pentaho.reporting.libraries.base.config.Configuration loadConfiguration()
        Loads the configuration. This will be called exactly once.
        Specified by:
        loadConfiguration in class org.pentaho.reporting.libraries.base.boot.AbstractBoot
        The configuration.
      • performBoot

        protected void performBoot()
        Performs the actual boot process.
        Specified by:
        performBoot in class org.pentaho.reporting.libraries.base.boot.AbstractBoot
      • getUserConfig

        public static org.pentaho.reporting.libraries.base.config.Configuration getUserConfig()
        Returns the user supplied global configuration.
        the user configuration, if any.
      • setUserConfig

        public static void setUserConfig​(org.pentaho.reporting.libraries.base.config.Configuration config)
        Defines the global user configuration.
        config - the user configuration.
      • isModuleAvailable

        public boolean isModuleAvailable​(String moduleClass)
        A helper method that checks, whether a given module is available. The result of this method is undefined if the system has no been booted yet.
        moduleClass - the class-name of the module that should be tested.
        true, if the module is available and has been initialized correctly, false otherwise.
      • parseVersionId

        public static int parseVersionId​(String text)
      • printVersion

        public static String printVersion​(int versionId)
      • computeCurrentVersionId

        public static int computeCurrentVersionId()
      • computeVersionId

        public static int computeVersionId​(int prptVersionMajorRaw,
                                           int prptVersionMinorRaw,
                                           int prptVersionPatchRaw)
      • isValidVersion

        protected ClassicEngineBoot.VersionValidity isValidVersion​(int prptVersionMajorRaw,
                                                                   int prptVersionMinorRaw,
                                                                   int prptVersionPatchRaw,
                                                                   org.pentaho.reporting.libraries.base.versioning.ProjectInformation info)
      • isEnforceCompatibilityFor

        public static boolean isEnforceCompatibilityFor​(int level,
                                                        int prptVersionMajorRaw,
                                                        int prptVersionMinorRaw)
      • isEnforceCompatibilityFor

        public static boolean isEnforceCompatibilityFor​(int level,
                                                        int prptVersionMajorRaw,
                                                        int prptVersionMinorRaw,
                                                        int prptVersionPatchRaw)