Package org.esa.snap.core.gpf.annotations

Annotation Interface Parameter

@Documented @Inherited @Retention(RUNTIME) @Target(FIELD) public @interface Parameter
Marks a processing parameter field of an Operator. The field can be of any type.

  • Element Details

    • alias

      String alias
      Returns:
      An alias name for the parameter. Defaults to the empty string (= not set).
      Default:
      ""

    • itemAlias

      String itemAlias
      Returns:
      An alias name for the elements of a parameter array. Forces element-wise array conversion from and to DOM representation. Defaults to the empty string (= not set).
      Default:
      ""

    • defaultValue

      String defaultValue
      Gets the parameter's default value. The default value set is given as a textual representations of the actual value. The framework creates the actual value set by converting the text value to an object using the associated Converter.
      Returns:
      The default value. Defaults to the empty string (= not set).
      See Also:
      Default:
      ""

    • label

      String label
      Returns:
      A human-readable version of the name to be used in user interfaces. Defaults to the empty string (= not set).
      Default:
      ""

    • unit

      String unit
      Returns:
      The parameter physical unit. Defaults to the empty string (= not set).
      Default:
      ""

    • description

      String description
      Returns:
      The parameter description. Defaults to the empty string (= not set).
      Default:
      ""

    • valueSet

      String[] valueSet
      Gets the set of values which can be assigned to a parameter field. The value set is given as textual representations of the actual values. The framework creates the actual value set by converting each text value to an object value using the associated Converter.
      Returns:
      The value set.Defaults to empty array (= not set).
      See Also:
      Default:
      {}

    • interval

      String interval
      Gets the valid interval for numeric parameters, e.g. "[10,20)": in the range 10 (inclusive) to 20 (exclusive).
      Returns:
      The valid interval. Defaults to empty string (= not set).
      Default:
      ""

    • condition

      String condition
      Gets a conditional expression which must return true in order to indicate that the parameter value is valid, e.g. "value > 2.5".
      Returns:
      A conditional expression. Defaults to empty string (= not set).
      Default:
      ""

    • pattern

      String pattern
      Gets a regular expression pattern to which a textual parameter value must match in order to indicate a valid value, e.g. "a*".
      Returns:
      A regular expression pattern. Defaults to empty string (= not set).
      See Also:
      Default:
      ""

    • format

      String format
      Gets a format string to which a textual parameter value must match in order to indicate a valid value, e.g. "yyyy-MM-dd HH:mm:ss.Z".
      Returns:
      A format string. Defaults to empty string (= not set).
      See Also:
      Default:
      ""

    • notNull

      boolean notNull
      Parameter value must not be null?
      Returns:
      true, if so. Defaults to false.
      Default:
      false

    • notEmpty

      boolean notEmpty
      Parameter value must not be an empty string?
      Returns:
      true, if so. Defaults to false.
      Default:
      false

    • validator

      Class<? extends Validator> validator
      A validator to be used to validate a parameter value.
      Returns:
      The validator class.
      Default:
      com.bc.ceres.binding.Validator.class

    • converter

      Class<? extends Converter> converter
      A converter to be used to convert a text to the parameter value and vice versa.
      Returns:
      The converter class.
      Default:
      com.bc.ceres.binding.Converter.class

    • domConverter

      Class<? extends DomConverter> domConverter
      A converter to be used to convert an (XML) DOM to the parameter value and vice versa.
      Returns:
      The DOM converter class.
      Default:
      com.bc.ceres.binding.dom.DomConverter.class

    • rasterDataNodeType

      Class<? extends RasterDataNode> rasterDataNodeType
      Specifies which RasterDataNode subclass of the source products is used to fill the valueSet() for this parameter.
      Returns:
      The raster data node type.
      Default:
      org.esa.snap.core.datamodel.RasterDataNode.class