Package nz.org.riskscape.engine.model

Class ModelParameter

java.lang.Object
nz.org.riskscape.engine.model.ModelParameter
public class ModelParameter extends Object

Represents a Parameter in a Model that can be customized by the user, via a ParameterTemplate

  • Constructor Details

  • Method Details

    • getDescription

      public String getDescription(Locale locale)
      Returns:
      a detailed user-friendly description of the parameter, i.e. help text

    • getLabel

      public String getLabel()
      Returns:
      a user-friendly label for this parameter, like what would be displayed in the UI

    • toUserFriendlyString

      protected String toUserFriendlyString(String input)

    • getProperties

      public Set<ParameterProperty> getProperties()
      Returns:
      any traits that this parameter has, e.g. hidden, read-only, numeric, etc

    • getChoices

      public List<ParameterTemplate.Choice> getChoices(Locale locale)
      Returns:
      a set of pre-defined values that this parameter can accept

    • getValue

      public Object getValue(BoundParameters bound)

    • getName

      public String getName()

    • getParameter

      public Parameter getParameter()

    • getTemplate

      public ParameterTemplate getTemplate()