Package de.iip_ecosphere.platform.configuration

Class EasySetup

  • public class EasySetup
extends java.lang.Object
    Settings for EASy-Producer.
    Author:
    Holger Eichelberger, SSE

    • Constructor Summary

      Constructors 
      Constructor Description
      EasySetup()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.io.File> getAdditionalIvmlFolders()
      Returns additional IVML folders to be considered when loading the configuration model.
      java.io.File getBase()
      Returns the target base for making relative artifact paths absolute.
      java.io.File getGenTarget()
      Returns the target folder for artifact generation.
      java.io.File getIvmlConfigFolder()
      Returns the IVML configuration folder containing the platform configuration.
      java.io.File getIvmlMetaModelFolder()
      Returns the IVML folder containing the platform meta model as well as the VIL and VTL scripts.
      java.lang.String getIvmlModelName()
      Returns the IVML model name.
      EasyLogLevel getLogLevel()
      Returns whether EASy-Producer verbose output, in particular during startup, shall be emitted.
      void reset()
      Resets the setup to default values, e.g., for testing.
      void setAdditionalIvmlFolders​(java.util.List<java.io.File> additionalIvmlFolders)
      Returns additional IVML folders to be considered when loading the configuration model.
      void setBase​(java.io.File base)
      Defines the base folder for making relative paths absolute.
      void setGenTarget​(java.io.File genTarget)
      Defines the target folder for artifact generation.
      void setIvmlConfigFolder​(java.io.File ivmlConfigFolder)
      Defines the IVML configuration folder containing the platform configuration.
      void setIvmlMetaModelFolder​(java.io.File ivmlMetaModelFolder)
      Defines the IVML meta model folder containing the platform meta model.
      void setIvmlModelName​(java.lang.String ivmlModelName)
      Returns the IVML model name.
      void setLogLevel​(EasyLogLevel logLevel)
      Defines whether EASy-Producer verbose output, in particular during startup, shall be emitted.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • PLATFORM_META_MODEL_NAME

        public static final java.lang.String PLATFORM_META_MODEL_NAME
        See Also:
        Constant Field Values

      • base

        private java.io.File base

      • genTarget

        private java.io.File genTarget

      • ivmlMetaModelFolder

        private java.io.File ivmlMetaModelFolder

      • ivmlConfigFolder

        private java.io.File ivmlConfigFolder

      • additionalIvmlFolders

        private java.util.List<java.io.File> additionalIvmlFolders

      • ivmlModelName

        private java.lang.String ivmlModelName

    • Constructor Detail

      • EasySetup

        public EasySetup()

    • Method Detail

      • reset

        public void reset()
        Resets the setup to default values, e.g., for testing.

      • getIvmlModelName

        public java.lang.String getIvmlModelName()
        Returns the IVML model name.
        Returns:
        the IVML model name, by default "IIPEcosphere"

      • getBase

        public java.io.File getBase()
        Returns the target base for making relative artifact paths absolute.
        Returns:
        the base folder, by default ..

      • getGenTarget

        public java.io.File getGenTarget()
        Returns the target folder for artifact generation. Shall be within getBase().
        Returns:
        the target folder, by default gen.

      • getIvmlMetaModelFolder

        public java.io.File getIvmlMetaModelFolder()
        Returns the IVML folder containing the platform meta model as well as the VIL and VTL scripts.
        Returns:
        the IVML folder folder, by default model if it exists or src/main/easy.

      • getIvmlConfigFolder

        public java.io.File getIvmlConfigFolder()
        Returns the IVML configuration folder containing the platform configuration.
        Returns:
        the IVML configuration folder if different from getIvmlMetaModelFolder(), by default null.

      • setIvmlModelName

        public void setIvmlModelName​(java.lang.String ivmlModelName)
        Returns the IVML model name. [required by SnakeYaml]
        Parameters:
        ivmlModelName - the IVML model name

      • setBase

        public void setBase​(java.io.File base)
        Defines the base folder for making relative paths absolute. [required by SnakeYaml]
        Parameters:
        base - the base folder.

      • setGenTarget

        public void setGenTarget​(java.io.File genTarget)
        Defines the target folder for artifact generation. [required by SnakeYaml]
        Parameters:
        genTarget - the target folder.

      • setIvmlMetaModelFolder

        public void setIvmlMetaModelFolder​(java.io.File ivmlMetaModelFolder)
        Defines the IVML meta model folder containing the platform meta model. This folder is not interpreted relative to getBase(). [required by SnakeYaml]
        Parameters:
        ivmlMetaModelFolder - the IVML meta model folder

      • setIvmlConfigFolder

        public void setIvmlConfigFolder​(java.io.File ivmlConfigFolder)
        Defines the IVML configuration folder containing the platform configuration. This folder is not interpreted relative to getBase(). [required by SnakeYaml]
        Parameters:
        ivmlConfigFolder - the IVML configuration folder, shall be null if it is the same as getIvmlMetaModelFolder(), ignored if given and the same as getIvmlMetaModelFolder()

      • getLogLevel

        public EasyLogLevel getLogLevel()
        Returns whether EASy-Producer verbose output, in particular during startup, shall be emitted.
        Returns:
        true for verbose output, false else

      • setLogLevel

        public void setLogLevel​(EasyLogLevel logLevel)
        Defines whether EASy-Producer verbose output, in particular during startup, shall be emitted. [required by SnakeYaml]
        Parameters:
        logLevel - the easy logging level

      • getAdditionalIvmlFolders

        public java.util.List<java.io.File> getAdditionalIvmlFolders()
        Returns additional IVML folders to be considered when loading the configuration model. Usually, additional IVML folders are only used in very specialized (test) setups, e.g., to reuse a part of the model while the remainder of the (managed) configuration is for separation purposes in a different folder on the same level.
        Returns:
        the additional IVML folders, may be null for undefined

      • setAdditionalIvmlFolders

        public void setAdditionalIvmlFolders​(java.util.List<java.io.File> additionalIvmlFolders)
        Returns additional IVML folders to be considered when loading the configuration model. Usually, additional IVML folders are only used in very specialized (test) setups, e.g., to reuse a part of the model while the remainder of the (managed) configuration is for separation purposes in a different folder on the same level.
        Parameters:
        additionalIvmlFolders - the additional IVML folders (may be null for none, or empty)