parametervaluegroup.java

GEo 地理操作源代码

/*$************************************************************************************************
 **
 ** $Id: ParameterValueGroup.java,v 1.3 2004/05/12 18:52:17 desruisseaux Exp $
 **
 ** $Source: /cvsroot/geoapi/src/org/opengis/parameter/ParameterValueGroup.java,v $
 **
 ** Copyright (C) 2003 Open GIS Consortium, Inc. All Rights Reserved. http://www.opengis.org/Legal/
 **
 *************************************************************************************************/
package org.opengis.parameter;


/**
 * A group of related parameter values. The same group can be repeated more than once in an
 * {@linkplain org.opengis.referencing.operation.Operation operation} or higher level <code>ParameterValueGroup</code>,
 * if those instances contain different values of one or more {@link ParameterValue}s which suitably
 * distinquish among those groups.
 *  
 * @UML abstract CC_ParameterValueGroup
 * @author ISO 19111
 * @author <A HREF="http://www.opengis.org">OpenGIS&reg; consortium</A>
 * @version <A HREF="http://www.opengis.org/docs/03-073r1.zip">Abstract specification 2.0</A>
 *
 * @see OperationParameterGroup
 * @see ParameterValue
 */
public interface ParameterValueGroup extends GeneralParameterValue {
    /**
     * Returns the group this value belong to.
     *
     * @return The abstract definition of this group of parameters.
     * @UML association valuesOfGroup
     *
     * @rename Renamed <CODE>getDescriptor()</CODE> because <CODE>getGroup()</CODE> seems too
     *         restrictive, misleading (this method returns an abstract definition of a group
     *         of parameters, not the actual group), and for consistency with usage in other
     *         Java extensions (e.g.
     *         {@link javax.media.jai.ParameterList.html#getParameterListDescriptor ParameterList}).
     */
//  OperationParameterGroup getDescriptor();

    /**
     * Returns the values in this group.
     *
     * @return The values.
     * @UML association includesValue
     */
    GeneralParameterValue[] getValues();

    /**
     * Returns the first value in this group for the specified name. If no
     * {@linkplain ParameterValue parameter value} or group is found for the
     * given name, then this method search recursively in subgroups (if any).
     *
     * @param  name The case insensitive name of the parameter to search for.
     * @return The parameter value for the given name.
     * @throws ParameterNotFoundException if there is no parameter for the given name.
     */
    GeneralParameterValue getValue(String name) throws ParameterNotFoundException;

    /**
     * Returns a copy of this group of parameter values.
     * Included parameter values and subgroups Object cloned recursively.
     *
     * @return A copy of this group of parameter values.
     */
    Object clone();
}