public interface ParameterDescriptor extends DataElementDescriptor
Modifier and Type | Method and Description |
---|---|
String |
getCondition()
Gets a conditional expression which must return
true in order to indicate
that the parameter value is valid, e.g. |
Class<? extends Converter> |
getConverterClass()
A converter to be used to convert a text to the parameter value and vice versa.
|
String |
getDefaultValue()
Gets the parameter's default value.
|
Class<? extends DomConverter> |
getDomConverterClass()
A converter to be used to convert an (XML) DOM to the parameter value and vice versa.
|
String |
getFormat()
Gets a format string to which a textual parameter value must match in order to indicate
a valid value, e.g.
|
String |
getInterval()
Gets the valid interval for numeric parameters, e.g.
|
String |
getItemAlias() |
String |
getPattern()
Gets a regular expression pattern to which a textual parameter value must match in order to indicate
a valid value, e.g.
|
Class<? extends RasterDataNode> |
getRasterDataNodeClass()
Specifies which
RasterDataNode subclass of the source products is used
to fill the getValueSet() for this parameter. |
ParameterDescriptor[] |
getStructureMemberDescriptors() |
String |
getUnit() |
Class<? extends Validator> |
getValidatorClass()
A validator to be used to validate a parameter value.
|
String[] |
getValueSet()
Gets the set of values which can be assigned to a parameter field.
|
boolean |
isDeprecated()
Is the parameter marked as deprecated?
|
boolean |
isNotEmpty()
Parameter value must not be an empty string?
|
boolean |
isNotNull()
Parameter value must not be
null ? |
boolean |
isStructure() |
getDataType
getAlias, getDescription, getLabel, getName
String getItemAlias()
String getDefaultValue()
Converter
.getConverterClass()
String getUnit()
String[] getValueSet()
Converter
.getConverterClass()
String getInterval()
"[10,20)"
: in the range 10 (inclusive) to 20 (exclusive).String getCondition()
true
in order to indicate
that the parameter value is valid, e.g. "value > 2.5"
.String getPattern()
"a*"
.Pattern
String getFormat()
"yyyy-MM-dd HH:mm:ss.Z"
.Format
boolean isNotNull()
null
?true
, if so. Defaults to false
.boolean isNotEmpty()
true
, if so. Defaults to false
.boolean isDeprecated()
true
, if so. Defaults to false
.Class<? extends Validator> getValidatorClass()
Class<? extends Converter> getConverterClass()
Class<? extends DomConverter> getDomConverterClass()
Class<? extends RasterDataNode> getRasterDataNodeClass()
RasterDataNode
subclass of the source products is used
to fill the getValueSet()
for this parameter.boolean isStructure()
true
if the parameter type is a composite data structure.DataElementDescriptor.getDataType()
,
getStructureMemberDescriptors()
ParameterDescriptor[] getStructureMemberDescriptors()
DataElementDescriptor.getDataType()
,
isStructure()
Copyright © 2014–2017 European Space Agency (ESA). All rights reserved.