org.esa.snap.core.datamodel

Class ProductNodeNameValidator

java.lang.Object

org.esa.snap.core.datamodel.ProductNodeNameValidator

All Implemented Interfaces:

org.esa.snap.core.param.ParamValidator

public class ProductNodeNameValidator
extends Object
implements org.esa.snap.core.param.ParamValidator

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRODUCT_PROPERTY_KEY This key should only be specified if the requested productNodeName have to be unique inside the given product.

Constructor Summary

Constructors

Constructor and Description
ProductNodeNameValidator()

Method Summary

Modifier and Type	Method and Description
boolean	equalValues(org.esa.snap.core.param.Parameter parameter, Object value1, Object value2) Tests if the given two values are equal taking the given parameter information into account.
String	format(org.esa.snap.core.param.Parameter parameter, Object value) Converts the given value into a text taking the given parameter information into account.
Object	parse(org.esa.snap.core.param.Parameter parameter, String text) Converts the given text into a value taking the given parameter information into account.
void	validate(org.esa.snap.core.param.Parameter parameter, Object value) Tests if the given value passes all constraints given in the supplied parameter information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRODUCT_PROPERTY_KEY

public static final String PRODUCT_PROPERTY_KEY

This key should only be specified if the requested productNodeName have to be unique inside the given product. This applies to bandNames and tiePointGridNames.

See Also:

Constant Field Values

Constructor Detail

ProductNodeNameValidator

public ProductNodeNameValidator()

Method Detail

equalValues

public boolean equalValues(org.esa.snap.core.param.Parameter parameter,
                           Object value1,
                           Object value2)

Description copied from interface: org.esa.snap.core.param.ParamValidator

Tests if the given two values are equal taking the given parameter information into account.

Specified by:

equalValues in interface org.esa.snap.core.param.ParamValidator

Parameters:

parameter - the parameter, must not be null

value1 - the first value, can be null

value2 - the second value, can also be null

Returns:

true if the value are equal, false otherwise

format

public String format(org.esa.snap.core.param.Parameter parameter,
                     Object value)
              throws org.esa.snap.core.param.ParamFormatException

Description copied from interface: org.esa.snap.core.param.ParamValidator

Converts the given value into a text taking the given parameter information into account.

Specified by:

format in interface org.esa.snap.core.param.ParamValidator

Parameters:

parameter - the parameter, must not be null

value - the value to be converted into a text, can be null

Returns:

the value represented by the text, never null.

Throws:

org.esa.snap.core.param.ParamFormatException

parse

public Object parse(org.esa.snap.core.param.Parameter parameter,
                    String text)
             throws org.esa.snap.core.param.ParamParseException

Description copied from interface: org.esa.snap.core.param.ParamValidator

Converts the given text into a value taking the given parameter information into account.

Specified by:

parse in interface org.esa.snap.core.param.ParamValidator

Parameters:

parameter - the parameter, must not be null

text - the text to be converted into a value, must not be null

Returns:

the value represented by the text

Throws:

org.esa.snap.core.param.ParamParseException

validate

public void validate(org.esa.snap.core.param.Parameter parameter,
                     Object value)
              throws org.esa.snap.core.param.ParamValidateException

Description copied from interface: org.esa.snap.core.param.ParamValidator

Tests if the given value passes all constraints given in the supplied parameter information. The value can also be null since parameters can be allowed to have the value 'null'.

Specified by:

validate in interface org.esa.snap.core.param.ParamValidator

Parameters:

parameter - the parameter, must not be null

value - the value to be tested, can be null

Throws:

org.esa.snap.core.param.ParamValidateException