org.opengis.parameter.ParameterDescriptor Maven / Gradle / Ivy
Show all versions of gt-opengis Show documentation
/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2003-2005, Open Geospatial Consortium Inc.
*
* All Rights Reserved. http://www.opengis.org/legal/
*/
package org.opengis.parameter;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
import java.util.Set;
import javax.measure.Unit;
import org.opengis.annotation.Extension;
import org.opengis.annotation.UML;
import org.opengis.util.CodeList;
/**
* The definition of a parameter used by an operation method. Most parameter values are numeric, but
* other types of parameter values are possible.
*
* @param The type of parameter values.
* @version Abstract
* specification 2.0
* @author Martin Desruisseaux (IRD)
* @author Jody Garnett (Refractions Research)
* @since GeoAPI 2.0
* @see ParameterValue
* @see ParameterDescriptorGroup
*/
@UML(identifier = "CC_OperationParameter", specification = ISO_19111)
public interface ParameterDescriptor extends GeneralParameterDescriptor {
/**
* Creates a new instance of {@linkplain ParameterValue parameter value} initialized with the
* {@linkplain #getDefaultValue default value}. The {@linkplain ParameterValue#getDescriptor
* parameter value descriptor} for the created parameter value will be {@code this} object.
*/
@Extension
ParameterValue createValue();
/**
* Returns the class that describe the type of the parameter.
*
* @return The type of parameter values.
*/
@UML(identifier = "GC_ParameterInfo.type", obligation = MANDATORY, specification = ISO_19111)
Class getValueClass();
/**
* Returns the set of allowed values when these are restricted to some finite set or returns
* {@code null} otherwise. The returned set usually contains {@linkplain CodeList code list} or
* enumeration elements.
*
* @return A finite set of valid values (usually from a {@linkplain CodeList code list}), or
* {@code null} if it doesn't apply.
*/
@Extension
Set getValidValues();
/**
* Returns the default value for the parameter. The return type can be any type including a
* {@link Number} or a {@link String}. If there is no default value, then this method returns
* {@code null}.
*
* @return The default value, or {@code null} in none.
*/
@UML(
identifier = "GC_ParameterInfo.defaultValue",
obligation = OPTIONAL,
specification = ISO_19111
)
T getDefaultValue();
/**
* Returns the minimum parameter value.
*
* If there is no minimum value, or if minimum value is inappropriate for the {@linkplain
* #getValueClass parameter type}, then this method returns {@code null}.
*
*
When the getValueClass() is an array or Collection getMinimumValue may be used to
* constrain the contained elements.
*
* @return The minimum parameter value (often an instance of {@link Double}), or {@code null}.
*/
@UML(
identifier = "GC_ParameterInfo.minimumValue",
obligation = OPTIONAL,
specification = ISO_19111
)
Comparable getMinimumValue();
/**
* Returns the maximum parameter value.
*
* If there is no maximum value, or if maximum value is inappropriate for the {@linkplain
* #getValueClass parameter type}, then this method returns {@code null}.
*
*
When the getValueClass() is an array or Collection getMaximumValue may be used to
* constratin the contained elements.
*
* @return The minimum parameter value (often an instance of {@link Double}), or {@code null}.
*/
@UML(
identifier = "GC_ParameterInfo.maximumValue",
obligation = OPTIONAL,
specification = ISO_19111
)
Comparable getMaximumValue();
/**
* Returns the unit for {@linkplain #getDefaultValue default}, {@linkplain #getMinimumValue
* minimum} and {@linkplain #getMaximumValue maximum} values. This attribute apply only if the
* values is of numeric type (usually an instance of {@link Double}).
*
* @return The unit for numeric value, or {@code null} if it doesn't apply to the value type.
*/
@Extension
Unit getUnit();
}