Application: gvSIG desktop » gvSIG tools: Vector editing

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2014 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.vectorediting.lib.api;

import java.util.Map;

import java.util.Set;

import org.gvsig.fmap.geom.Geometry;

/**

 * <p>

 * EditingServiceParameter represents values needed by services to work.

 * This parameters can be several type at the same type. For example, if

 * services needs the radius of a circle, that value can be a position of map or

 * a double value.

 * </p>

 *

 * @author gvSIG team.

 * @version $Id$

 *

 */

public interface EditingServiceParameter {

    /**

     * TYPE represents the available type of parameters. A parameter can be of

     * several types at the same type. The types of parameters are:

     *

     * - Position: this kind of parameter expects a position in map.

     *

     * - List of positions this kind of parameter expects a position in map.

     *

     * - Option: this kind of parameter expects an option. Options is used to

     * change functionality of providers or to do actions. For example, an

     * option of Regular polygon can be "sides" that indicates side number of

     * regular polygon.

     *

     * - Value: this kind of parameter expects an value.

     *

     * - Selection: this kind of parameters expects a selection.

     *

     * - Geometry: this kind of parameters expects a selection. See

     * {@link EditingServiceParameter#getGeometryType()} to know the type of

     * geometry is expected

     *

     * @author llmarques

     *

     */

    public enum TYPE {

        POSITION, LIST_POSITIONS, OPTION, VALUE, SELECTION, GEOMETRY

    }

    /**

     * Gets types of this parameter.

     *

     * @return A <code> Set </code> of parameter types.

     */

    public Set<TYPE> getTypes();

    /**

     * Gets a name of parameter.

     *

     * @return Parameter name

     */

    public String getName();

    /**

     * Gets a description of parameter. Description is used to show a message on

     * console.

     *

     * @return Description parameter.

     */

    public String getDescription();

    /**

     * Gets the default value of this parameter. If this parameter doesn't have

     * default value, it will return null.

     *

     * @return Default value of this parameter. Null if this parameter doesn't

     *         have default value.

     */

    public Object getDefaultValue();

    /**

     * Sets the default value of this parameter.

     */

    public void setDefaultValue(Object value);

    /**

     * If parameter is of type Geometry returns the type of geometry

     * required by this parameter. Else return <code>NULL</code> geometry type.

     * See {@link Geometry.TYPES}

     *

     * @return Type of geometry required by this parameters. If parameter does

     *         not require any geometry return null.

     */

    public int getGeometryType();

    /**

     * If parameter is of type Options, returns a <code>Map</code> with valid

     * options. The map is composed by identifiers and values.

     *

     * The identifiers are used to check if an option is valid when provider

     * receives an option. For example, an identifier of the option "Arc mode"

     * could be "A".

     *

     * @return Map with identifiers and values of valid options.

     */

    public Map<String, String> getOptions();

    /**

     * Returns "true" if it does not have to be displayed for the user to fill

     * in, but it can be filled in by the user so that other parameters depend

     * on it.

     *

     * @return is optional

     */

    public boolean isOptional();

}