Package org.esa.snap.core.gpf.descriptor

Interface ParameterDescriptor

    • Method Detail

      • getItemAlias

        String getItemAlias()
        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).

      • getDefaultValue

        String getDefaultValue()
        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:
        getConverterClass()

      • getUnit

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

      • getValueSet

        String[] getValueSet()
        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:
        getConverterClass()

      • getInterval

        String getInterval()
        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).

      • getCondition

        String getCondition()
        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).

      • getPattern

        String getPattern()
        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:
        Pattern

      • getFormat

        String getFormat()
        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:
        Format

      • isNotNull

        boolean isNotNull()
        Parameter value must not be null?
        Returns:
        true, if so. Defaults to false.

      • isNotEmpty

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

      • isDeprecated

        boolean isDeprecated()
        Is the parameter marked as deprecated?
        Returns:
        true, if so. Defaults to false.

      • getValidatorClass

        Class<? extends Validator> getValidatorClass()
        A validator to be used to validate a parameter value.
        Returns:
        The validator class.

      • getConverterClass

        Class<? extends Converter> getConverterClass()
        A converter to be used to convert a text to the parameter value and vice versa.
        Returns:
        The converter class.

      • getDomConverterClass

        Class<? extends DomConverter> getDomConverterClass()
        A converter to be used to convert an (XML) DOM to the parameter value and vice versa.
        Returns:
        The DOM converter class.

      • getRasterDataNodeClass

        Class<? extends RasterDataNode> getRasterDataNodeClass()
        Specifies which RasterDataNode subclass of the source products is used to fill the getValueSet() for this parameter.
        Returns:
        The raster data node type.