Package org.gvsig.vectorediting.lib.api

Interface EditingServiceParameter

public interface EditingServiceParameter

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.

Version:
$Id$
Author:
gvSIG team.

  • Method Details

    • getTypes

      Set<EditingServiceParameter.TYPE> getTypes()
      Gets types of this parameter.
      Returns:
      A Set of parameter types.

    • getName

      String getName()
      Gets a name of parameter.
      Returns:
      Parameter name

    • getDescription

      String getDescription()
      Gets a description of parameter. Description is used to show a message on console.
      Returns:
      Description parameter.

    • setDescription

      void setDescription(String newDescription)
      Sets the description. Description is used to show a message on console.
      Parameters:
      newDescription -

    • getDefaultValue

      Object getDefaultValue()
      Gets the default value of this parameter. If this parameter doesn't have default value, it will return null.
      Returns:
      Default value of this parameter. Null if this parameter doesn't have default value.

    • setDefaultValue

      void setDefaultValue(Object value)
      Sets the default value of this parameter.
      Parameters:
      value -

    • getConsoleDefaultValue

      String getConsoleDefaultValue()

    • getGeometryType

      int getGeometryType()
      If parameter is of type Geometry returns the type of geometry required by this parameter. Else return NULL geometry type. See Geometry.TYPES
      Returns:
      Type of geometry required by this parameters. If parameter does not require any geometry return null.

    • getOptions

      Map<String,String> getOptions()
      If parameter is of type Options, returns a Map 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".
      Returns:
      Map with identifiers and values of valid options.

    • getOptions2

      EditingServiceParameterOptions getOptions2()

    • isOptional

      boolean isOptional()
      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.
      Returns:
      is optional

    • getDataType

      int getDataType()

    • isValidValue

      boolean isValidValue(Object value)

    • coerceValue

      Object coerceValue(Object value)

    • getAllowNull

      boolean getAllowNull()