T - The type of elements to be returned by ParameterValue.getValue().public class DefaultParameterDescriptor<T> extends AbstractParameterDescriptor implements ParameterDescriptor<T>
For numeric values, the value class is usually
Double.class, Integer.class or some other Java
wrapper class.
This class contains numerous convenience constructors. But all of them ultimately invoke a single, full-featured constructor. All other constructors are just shortcuts.
Parameter,
DefaultParameterDescriptorGroup,
Serialized FormEMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATORSINGLE_LINEALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY| Constructor and Description |
|---|
DefaultParameterDescriptor(Citation authority,
String name,
Class<T> valueClass,
T[] validValues,
T defaultValue,
Comparable<T> minimum,
Comparable<T> maximum,
Unit<?> unit,
boolean required)
Constructs a parameter from an authority and a name.
|
DefaultParameterDescriptor(Map<String,?> properties,
Class<T> valueClass,
T[] validValues,
T defaultValue,
Comparable<T> minimum,
Comparable<T> maximum,
Unit<?> unit,
boolean required)
Constructs a parameter from a set of properties.
|
DefaultParameterDescriptor(ParameterDescriptor<T> descriptor)
Constructs a descriptor with the same values than the specified one.
|
DefaultParameterDescriptor(String name,
Class<T> valueClass,
T[] validValues,
T defaultValue)
Constructs a mandatory parameter for a set of predefined values.
|
| Modifier and Type | Method and Description |
|---|---|
static DefaultParameterDescriptor<Double> |
create(Map<String,?> properties,
double defaultValue,
double minimum,
double maximum,
Unit<?> unit,
boolean required)
Constructs a descriptor for a parameter in a range of floating point values.
|
static DefaultParameterDescriptor<Integer> |
create(Map<String,?> properties,
int defaultValue,
int minimum,
int maximum,
boolean required)
Constructs a descriptor for a parameter in a range of integer values.
|
static <T> DefaultParameterDescriptor<T> |
create(String name,
CharSequence remarks,
Class<T> valueClass,
T defaultValue,
boolean required)
Constructs a descriptor from a name and a default value.
|
static DefaultParameterDescriptor<Double> |
create(String name,
double defaultValue,
double minimum,
double maximum,
Unit<?> unit)
Constructs a descriptor for a mandatory parameter in a range of floating point values.
|
static DefaultParameterDescriptor<Integer> |
create(String name,
int defaultValue,
int minimum,
int maximum)
Constructs a descriptor for a mandatory parameter in a range of integer values.
|
ParameterValue<T> |
createValue()
Creates a new instance of parameter value
initialized with the default value.
|
boolean |
equals(AbstractIdentifiedObject object,
boolean compareMetadata)
Compares the specified object with this parameter for equality.
|
T |
getDefaultValue()
Returns the default value for the parameter.
|
int |
getMaximumOccurs()
The maximum number of times that values for this parameter group or parameter can be
included.
|
Comparable<T> |
getMaximumValue()
Returns the maximum parameter value.
|
Comparable<T> |
getMinimumValue()
Returns the minimum parameter value.
|
Unit<?> |
getUnit()
|
Set<T> |
getValidValues()
If this parameter allows only a finite set of values, returns this set.
|
Class<T> |
getValueClass()
Returns the class that describe the type of the parameter.
|
int |
hashCode()
Returns a hash value for this parameter.
|
formatWKT, getMinimumOccursasSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches, nameMatchescleanupThreadLocals, toString, toWKT, toWKT, toWKT, toWKTgetMinimumOccursgetAlias, getIdentifiers, getName, getRemarks, toWKTpublic DefaultParameterDescriptor(ParameterDescriptor<T> descriptor)
descriptor - The descriptor to copy.public DefaultParameterDescriptor(String name, Class<T> valueClass, T[] validValues, T defaultValue)
name - The parameter name.valueClass - The class that describe the type of the parameter.validValues - A finite set of valid values (usually from a {linkplain
org.opengis.util.CodeList code list}) or null if it doesn't apply.defaultValue - The default value for the parameter, or null.public DefaultParameterDescriptor(Citation authority, String name, Class<T> valueClass, T[] validValues, T defaultValue, Comparable<T> minimum, Comparable<T> maximum, Unit<?> unit, boolean required)
authority - The authority (e.g. OGC).name - The parameter name.valueClass - The class that describe the type of the parameter.validValues - A finite set of valid values (usually from a {linkplain
org.opengis.util.CodeList code list}) or null if it doesn't apply.defaultValue - The default value for the parameter, or null.minimum - The minimum parameter value, or null.maximum - The maximum parameter value, or null.unit - The unit for default, minimum and maximum values.required - true if this parameter is required, or false if it is
optional.public DefaultParameterDescriptor(Map<String,?> properties, Class<T> valueClass, T[] validValues, T defaultValue, Comparable<T> minimum, Comparable<T> maximum, Unit<?> unit, boolean required)
properties - Set of properties. Should contains at least "name".valueClass - The class that describe the type of the parameter.validValues - A finite set of valid values (usually from a {linkplain
org.opengis.util.CodeList code list}) or null if it doesn't apply.defaultValue - The default value for the parameter, or null.minimum - The minimum parameter value, or null.maximum - The maximum parameter value, or null.unit - The unit for default, minimum and maximum values.required - true if this parameter is required, or false if it is
optional.public static DefaultParameterDescriptor<Integer> create(String name, int defaultValue, int minimum, int maximum)
name - The parameter name.defaultValue - The default value for the parameter.minimum - The minimum parameter value, or Integer.MIN_VALUE if none.maximum - The maximum parameter value, or Integer.MAX_VALUE if none.public static DefaultParameterDescriptor<Integer> create(Map<String,?> properties, int defaultValue, int minimum, int maximum, boolean required)
properties - The parameter properties (name, identifiers, alias...).defaultValue - The default value for the parameter.minimum - The minimum parameter value, or Integer.MIN_VALUE if none.maximum - The maximum parameter value, or Integer.MAX_VALUE if none.required - true if this parameter is required, false otherwise.public static DefaultParameterDescriptor<Double> create(String name, double defaultValue, double minimum, double maximum, Unit<?> unit)
name - The parameter name.defaultValue - The default value for the parameter, or Double.NaN if none.minimum - The minimum parameter value, or Double.NEGATIVE_INFINITY if none.maximum - The maximum parameter value, or Double.POSITIVE_INFINITY if none.unit - The unit for default, minimum and maximum values.public static DefaultParameterDescriptor<Double> create(Map<String,?> properties, double defaultValue, double minimum, double maximum, Unit<?> unit, boolean required)
properties - The parameter properties (name, identifiers, alias...).defaultValue - The default value for the parameter, or Double.NaN if none.minimum - The minimum parameter value, or Double.NEGATIVE_INFINITY if none.maximum - The maximum parameter value, or Double.POSITIVE_INFINITY if none.unit - The unit of measurement for default, minimum and maximum values.required - true if this parameter is required, false otherwise.public static <T> DefaultParameterDescriptor<T> create(String name, CharSequence remarks, Class<T> valueClass, T defaultValue, boolean required)
T - The parameter type.name - The parameter name.remarks - An optional description as a String or an InternationalString.valueClass - The parameter type.defaultValue - The default value.required - true if this parameter is required, false otherwise.public int getMaximumOccurs()
getMaximumOccurs in interface GeneralParameterDescriptorgetMaximumOccurs in class AbstractParameterDescriptorAbstractParameterDescriptor.getMinimumOccurs()public ParameterValue<T> createValue()
this object.createValue in interface GeneralParameterDescriptorcreateValue in interface ParameterDescriptor<T>createValue in class AbstractParameterDescriptorpublic Class<T> getValueClass()
getValueClass in interface ParameterDescriptor<T>public Set<T> getValidValues()
null if this parameter doesn't limits values to a finite set.getValidValues in interface ParameterDescriptor<T>null if it doesn't apply.public T getDefaultValue()
Number or a String. If there is no default value, then this method returns
null.getDefaultValue in interface ParameterDescriptor<T>null in none.public Comparable<T> getMinimumValue()
null.getMinimumValue in interface ParameterDescriptor<T>Double), or null.public Comparable<T> getMaximumValue()
null.getMaximumValue in interface ParameterDescriptor<T>Double), or null.public Unit<?> getUnit()
Double).getUnit in interface ParameterDescriptor<T>null if it doesn't apply to the value type.public boolean equals(AbstractIdentifiedObject object, boolean compareMetadata)
equals in class AbstractParameterDescriptorobject - The object to compare to this.compareMetadata - true for performing a strict comparaison, or false for
comparing only properties relevant to transformations.true if both objects are equal.public int hashCode()
hashCode in class AbstractParameterDescriptorCopyright © 1996–2022 Geotools. All rights reserved.