Package de.iip_ecosphere.platform.configuration.easyProducer

Class EasySetup

java.lang.Object
de.iip_ecosphere.platform.configuration.easyProducer.EasySetup
public class EasySetup extends Object
Settings for EASy-Producer.
Author:
Holger Eichelberger, SSE

  • Field Details

    • PLATFORM_META_MODEL_NAME

      public static final String PLATFORM_META_MODEL_NAME
      See Also:

    • base

      private File base

    • genTarget

      private File genTarget

    • ivmlMetaModelFolder

      private File ivmlMetaModelFolder

    • ivmlConfigFolder

      private File ivmlConfigFolder

    • additionalIvmlFolders

      private List<File> additionalIvmlFolders

    • ivmlModelName

      private String ivmlModelName

    • logLevel

      private EasyLogLevel logLevel

  • Constructor Details

    • EasySetup

      public EasySetup()

  • Method Details

    • getTestingEasyModelParent

      public static String getTestingEasyModelParent()
      Returns the folder for testing EASy models.
      Returns:
      the folder, per default ".", or the value in "-Dokto.test.easy.model.parent"

    • reset

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

    • getIvmlModelName

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

    • getBase

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

    • getGenTarget

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

    • getIvmlMetaModelFolder

      public 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 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(String ivmlModelName)
      Returns the IVML model name. [required by SnakeYaml]
      Parameters:
      ivmlModelName - the IVML model name

    • setBase

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

    • setGenTarget

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

    • setIvmlMetaModelFolder

      public void setIvmlMetaModelFolder(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(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 List<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(List<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)