Class NumberField

java.lang.Object
com.inet.taskplanner.server.api.field.Field
com.inet.taskplanner.server.api.field.NumberField

@JsonData public class NumberField extends Field
A field that takes an integer number as input The field supports place holders from the TaskPlanner, which has to be accounted for
Since:
taskplanner 21.0
  • Constructor Details

    • NumberField

      public NumberField(String key, String label)
      Construct the numeric field
      Parameters:
      key - the key of the field
      label - the label of the field
      Since:
      taskplanner 21.0
    • NumberField

      public NumberField(String key, String label, List<com.inet.config.structure.model.UnitConfigProperty.Unit> units)
      Construct the numeric field including a list of UnitConfigProperty.Unit to select between with automatic recalculation.
      Parameters:
      key - the key of the field
      label - the label of the field
      units - the definition of the units for this field
      Since:
      taskplanner 21.0
  • Method Details

    • isValidValue

      public static boolean isValidValue(String value)
      Returns true, if the value is valid
      Parameters:
      value - the value to check
      Returns:
      true, if the value is valid
      Since:
      taskplanner 21.0
    • patchResultPlaceholderInValue

      public String patchResultPlaceholderInValue(String value, List<JobResultContainer> results)
      Override to replace the placeholders with the values from the results
      Overrides:
      patchResultPlaceholderInValue in class Field
      Parameters:
      value - the value to be patched
      results - the results that contain the meta properties that are replaced
      Returns:
      the new value with replaced placeholders
    • patchSeriesPlaceholderInValue

      public String patchSeriesPlaceholderInValue(String value, Map<String,String> seriesProperties)
      Override to replace the placeholders with the values from the series
      Overrides:
      patchSeriesPlaceholderInValue in class Field
      Parameters:
      value - the value to be patched
      seriesProperties - properties from the current series set
      Returns:
      the new value with replaced placeholders