org.gvsig.vectorediting.lib.spi

Class DefaultEditingServiceParameter

java.lang.Object

org.gvsig.vectorediting.lib.spi.DefaultEditingServiceParameter

All Implemented Interfaces:

EditingServiceParameter

public class DefaultEditingServiceParameter
extends Object
implements EditingServiceParameter

Nested Class Summary

Nested classes/interfaces inherited from interface org.gvsig.vectorediting.lib.api.EditingServiceParameter

EditingServiceParameter.TYPE

Constructor Summary

Constructors

Constructor and Description
DefaultEditingServiceParameter(String theName, Object theDefaultValue, String theDescription, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(String theName, String theDescription, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(String theName, String theDescription, int theGeometryType, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(String theName, String theDescription, int theGeometryType, Map<String,String> theOptions, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(String theName, String theDescription, int theGeometryType, Map<String,String> theOptions, Object theDefaultValue, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(String theName, String theDescription, Map<String,String> theOptions, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(String theName, String theDescription, Map<String,String> theOptions, Object theDefaultValue, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(String theName, String theDescription, Object theDefaultValue, int theGeometryType, EditingServiceParameter.TYPE... theTypes)

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue() Gets the default value of this parameter.
String	getDescription() Gets a description of parameter.
int	getGeometryType() If parameter is of type Geometry returns the type of geometry required by this parameter.
String	getName() Gets a name of parameter.
Map<String,String>	getOptions() If parameter is of type Options, returns a Map with valid options.
Set<EditingServiceParameter.TYPE>	getTypes() Gets types of this parameter.
void	setDefaultValue(Object value) Sets the default value of this parameter.
void	setDescription(String newDescription)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(String theName,
                                      String theDescription,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(String theName,
                                      Object theDefaultValue,
                                      String theDescription,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(String theName,
                                      String theDescription,
                                      int theGeometryType,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(String theName,
                                      String theDescription,
                                      Object theDefaultValue,
                                      int theGeometryType,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(String theName,
                                      String theDescription,
                                      Map<String,String> theOptions,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(String theName,
                                      String theDescription,
                                      Map<String,String> theOptions,
                                      Object theDefaultValue,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(String theName,
                                      String theDescription,
                                      int theGeometryType,
                                      Map<String,String> theOptions,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(String theName,
                                      String theDescription,
                                      int theGeometryType,
                                      Map<String,String> theOptions,
                                      Object theDefaultValue,
                                      EditingServiceParameter.TYPE... theTypes)

Method Detail

getTypes

public Set<EditingServiceParameter.TYPE> getTypes()

Description copied from interface: EditingServiceParameter

Gets types of this parameter.

Specified by:

getTypes in interface EditingServiceParameter

Returns:

A Set of parameter types.

getName

public String getName()

Description copied from interface: EditingServiceParameter

Gets a name of parameter.

Specified by:

getName in interface EditingServiceParameter

Returns:

Parameter name

getDescription

public String getDescription()

Description copied from interface: EditingServiceParameter

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

Specified by:

getDescription in interface EditingServiceParameter

Returns:

Description parameter.

setDescription

public void setDescription(String newDescription)

getGeometryType

public int getGeometryType()

Description copied from interface: EditingServiceParameter

If parameter is of type Geometry returns the type of geometry required by this parameter. Else return NULL geometry type. See Geometry.TYPES

Specified by:

getGeometryType in interface EditingServiceParameter

Returns:

Type of geometry required by this parameters. If parameter does not require any geometry return null.

getOptions

public Map<String,String> getOptions()

Description copied from interface: EditingServiceParameter

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".

Specified by:

getOptions in interface EditingServiceParameter

Returns:

Map with identifiers and values of valid options.

getDefaultValue

public Object getDefaultValue()

Description copied from interface: EditingServiceParameter

Gets the default value of this parameter. If this parameter doesn't have default value, it will return null.

Specified by:

getDefaultValue in interface EditingServiceParameter

Returns:

Default value of this parameter. Null if this parameter doesn't have default value.

setDefaultValue

public void setDefaultValue(Object value)

Description copied from interface: EditingServiceParameter

Sets the default value of this parameter.

Specified by:

setDefaultValue in interface EditingServiceParameter