Package de.iip_ecosphere.platform.configuration.cfg

Class DashboardMapper.MapperParams

java.lang.Object
de.iip_ecosphere.platform.configuration.cfg.DashboardMapper.MapperParams
Enclosing interface:
DashboardMapper
public static class DashboardMapper.MapperParams extends Object
Represents the mapper parameters.
Author:
Holger Eichelberger, SSE

  • Field Details

    • mainModelName

      private String mainModelName

    • modelFolder

      private File modelFolder

    • metaModelFolder

      private File metaModelFolder

    • outputFile

      private File outputFile

    • pluginId

      private String pluginId

    • postUrl

      private String postUrl

    • inContainer

      private boolean inContainer

  • Constructor Details

    • MapperParams

      public MapperParams(String mainModelName, File modelFolder)
      Creates a params instance.
      Parameters:
      mainModelName - the name of the configuration model to load/parse
      modelFolder - the model folder

  • Method Details

    • getMainModelName

      public String getMainModelName()
      Returns the main model name.
      Returns:
      the name of the configuration model to load/parse

    • setMainModelName

      public DashboardMapper.MapperParams setMainModelName(String mainModelName)
      Defines the main model name.
      Parameters:
      mainModelName - the name of the configuration model to load/parse
      Returns:
      this for chaining

    • getModelFolder

      public File getModelFolder()
      Returns the model folder.
      Returns:
      the folder where the configuration model can be found

    • setModelFolder

      public DashboardMapper.MapperParams setModelFolder(File modelFolder)
      Defines the model folder.
      Parameters:
      modelFolder - the folder where the configuration model can be found
      Returns:
      this for chaining

    • getMetaModelFolder

      public File getMetaModelFolder()
      Returns the metamodel folder.
      Returns:
      the optional folder where the meta model can be found, may be null for none

    • setMetaModelFolder

      public DashboardMapper.MapperParams setMetaModelFolder(File metaModelFolder)
      Defines the metamodel folder.
      Parameters:
      metaModelFolder - optional folder where the meta model can be found, may be null for none
      Returns:
      this for chaining

    • getOutputFile

      public File getOutputFile()
      Returns the output file.
      Returns:
      optional output file where the dashboard specification shall be wrote to, if null a default location will be assumed

    • setOutputFile

      public DashboardMapper.MapperParams setOutputFile(File outputFile)
      Defines the output file.
      Parameters:
      outputFile - optional output file where the dashboard specification shall be wrote to, if null a default location will be assumed
      Returns:
      this for chaining

    • getPluginId

      public String getPluginId()
      Returns the plugin id.
      Returns:
      the optional plugin id to use (may be null for the default, must be loaded before)

    • setPluginId

      public DashboardMapper.MapperParams setPluginId(String pluginId)
      Sets the plugin id.
      Parameters:
      pluginId - the optional plugin id to use (may be null for the default, must be loaded before)
      Returns:
      this for chaining

    • hasPluginId

      public boolean hasPluginId()
      Returns whether a pluginId was defined.
      Returns:
      true for there is a pluginId, false else

    • getPostUrl

      public String getPostUrl()
      Returns the REST API URL.
      Returns:
      the URL for posting the result directly to a HTTP/REST API, may be null or empty for none

    • setPostUrl

      public DashboardMapper.MapperParams setPostUrl(String postUrl)
      Sets the REST API URL.
      Parameters:
      postUrl - the URL for posting the result directly to a HTTP/REST API, may be null or empty for none
      Returns:
      this for chaining

    • hasPostUrl

      public boolean hasPostUrl()
      Returns whether a postURL was defined.
      Returns:
      true for there is a postUrl, false else

    • isInContainer

      public boolean isInContainer()
      Returns whether the mapper shall produce a mapping for processes running in containers.
      Returns:
      whether container configuration values are preferred

    • setInContainer

      public DashboardMapper.MapperParams setInContainer(boolean inContainer)
      Defines whether the mapper shall produce a mapping for processes running in containers.
      Parameters:
      inContainer - whether container configuration values are preferred
      Returns:
      this for chaining