org.opengis.parameter.GeneralParameterDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation

Standard interfaces implemented throughout the library.

There is a newer version: 24.2-oss84-1

/*
 *    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 org.opengis.annotation.Extension;
import org.opengis.annotation.UML;
import org.opengis.referencing.IdentifiedObject;

/**
 * Abstract definition of a parameter or group of parameters used by an operation method.
 *
 * @version Abstract
 *     specification 2.0
 * @author Martin Desruisseaux (IRD)
 * @author Jody Garnett (Refractions Research)
 * @since GeoAPI 2.0
 * @see GeneralParameterValue
 */
@UML(identifier = "CC_GeneralOperationParameter", specification = ISO_19111)
public interface GeneralParameterDescriptor extends IdentifiedObject {
    /**
     * Creates a new instance of {@linkplain GeneralParameterValue parameter value or group}
     * initialized with the {@linkplain ParameterDescriptor#getDefaultValue default value(s)}. The
     * {@linkplain GeneralParameterValue#getDescriptor parameter value descriptor} for the created
     * parameter value(s) will be {@code this} object.
     *
     * @return A new parameter initialized to its default value.
     */
    @Extension
    GeneralParameterValue createValue();

    /**
     * The minimum number of times that values for this parameter group or parameter are required.
     * The default value is one. A value of 0 means an optional parameter.
     *
     * @return The minimum occurence.
     * @see #getMaximumOccurs
     */
    @UML(identifier = "minimumOccurs", obligation = OPTIONAL, specification = ISO_19111)
    int getMinimumOccurs();

    /**
     * The maximum number of times that values for this parameter group or parameter can be
     * included. For a {@linkplain ParameterDescriptor single parameter}, the value is always 1. For
     * a {@linkplain ParameterDescriptorGroup parameter group}, it may vary. The default value is
     * one.
     *
     * @return The maximum occurence.
     * @see #getMinimumOccurs
     */
    @UML(
        identifier = "CC_OperationParameterGroup.maximumOccurs",
        obligation = OPTIONAL,
        specification = ISO_19111
    )
    int getMaximumOccurs();
}