org.gvsig.vectorediting.lib.spi

Class DefaultEditingServiceParameter

java.lang.Object

org.gvsig.vectorediting.lib.spi.DefaultEditingServiceParameter

All Implemented Interfaces:

EditingServiceParameter

public class DefaultEditingServiceParameter
extends java.lang.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(java.lang.String theName, java.lang.Object theDefaultValue, java.lang.String theDescription, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, boolean optional, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, EditingServiceParameterOptions options, java.lang.Object defaultValue, boolean optional, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, EditingServiceParameterOptions theOptions, java.lang.Object theDefaultValue, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, int theGeometryType, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, int theGeometryType, EditingServiceParameterOptions theOptions, java.lang.Object theDefaultValue, boolean optional, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, int theGeometryType, java.util.Map<java.lang.String,java.lang.String> theOptions, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, int theGeometryType, java.util.Map<java.lang.String,java.lang.String> theOptions, EditingServiceParameterOptions theOptions2, java.lang.Object theDefaultValue, boolean optional, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, int theGeometryType, java.util.Map<java.lang.String,java.lang.String> theOptions, java.lang.Object theDefaultValue, boolean optional, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, int theGeometryType, java.util.Map<java.lang.String,java.lang.String> theOptions, java.lang.Object theDefaultValue, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, java.util.Map<java.lang.String,java.lang.String> theOptions, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, java.util.Map<java.lang.String,java.lang.String> options, java.lang.Object defaultValue, boolean optional, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, java.util.Map<java.lang.String,java.lang.String> theOptions, java.lang.Object theDefaultValue, EditingServiceParameter.TYPE... theTypes)
DefaultEditingServiceParameter(java.lang.String theName, java.lang.String theDescription, java.lang.Object theDefaultValue, int theGeometryType, EditingServiceParameter.TYPE... theTypes)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	coerceValue(java.lang.Object value)
boolean	getAllowNull()
java.lang.String	getConsoleDefaultValue()
int	getDataType()
java.lang.Object	getDefaultValue() Gets the default value of this parameter.
java.lang.String	getDescription() Gets a description of parameter.
int	getGeometryType() If parameter is of type Geometry returns the type of geometry required by this parameter.
java.lang.String	getName() Gets a name of parameter.
java.util.Map<java.lang.String,java.lang.String>	getOptions() If parameter is of type Options, returns a Map with valid options.
EditingServiceParameterOptions	getOptions2()
java.util.Set<EditingServiceParameter.TYPE>	getTypes() Gets types of this parameter.
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.
boolean	isValidValue(java.lang.Object value)
DefaultEditingServiceParameter	setAllowNull(boolean allowNull)
DefaultEditingServiceParameter	setDataType(int dataType)
void	setDefaultValue(java.lang.Object value) Sets the default value of this parameter.
void	setDescription(java.lang.String newDescription) Sets the description.
void	setOptional(boolean optional)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(java.lang.String theName,
                                      java.lang.String theDescription,
                                      boolean optional,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(java.lang.String theName,
                                      java.lang.String theDescription,
                                      java.util.Map<java.lang.String,java.lang.String> options,
                                      java.lang.Object defaultValue,
                                      boolean optional,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(java.lang.String theName,
                                      java.lang.String theDescription,
                                      EditingServiceParameterOptions options,
                                      java.lang.Object defaultValue,
                                      boolean optional,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(java.lang.String theName,
                                      java.lang.String theDescription,
                                      EditingServiceParameterOptions theOptions,
                                      java.lang.Object theDefaultValue,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

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

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(java.lang.String theName,
                                      java.lang.String theDescription,
                                      int theGeometryType,
                                      EditingServiceParameterOptions theOptions,
                                      java.lang.Object theDefaultValue,
                                      boolean optional,
                                      EditingServiceParameter.TYPE... theTypes)

DefaultEditingServiceParameter

public DefaultEditingServiceParameter(java.lang.String theName,
                                      java.lang.String theDescription,
                                      int theGeometryType,
                                      java.util.Map<java.lang.String,java.lang.String> theOptions,
                                      EditingServiceParameterOptions theOptions2,
                                      java.lang.Object theDefaultValue,
                                      boolean optional,
                                      EditingServiceParameter.TYPE... theTypes)

Method Detail

getTypes

public java.util.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 java.lang.String getName()

Description copied from interface: EditingServiceParameter

Gets a name of parameter.

Specified by:

getName in interface EditingServiceParameter

Returns:

Parameter name

getDescription

public java.lang.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(java.lang.String newDescription)

Description copied from interface: EditingServiceParameter

Sets the description. Description is used to show a message on console.

Specified by:

setDescription in interface EditingServiceParameter

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 java.util.Map<java.lang.String,java.lang.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.

getOptions2

public EditingServiceParameterOptions getOptions2()

Specified by:

getOptions2 in interface EditingServiceParameter

getDefaultValue

public java.lang.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(java.lang.Object value)

Description copied from interface: EditingServiceParameter

Sets the default value of this parameter.

Specified by:

setDefaultValue in interface EditingServiceParameter

getConsoleDefaultValue

public java.lang.String getConsoleDefaultValue()

Specified by:

getConsoleDefaultValue in interface EditingServiceParameter

isOptional

public boolean isOptional()

Description copied from interface: EditingServiceParameter

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.

Specified by:

isOptional in interface EditingServiceParameter

Returns:

is optional

setOptional

public void setOptional(boolean optional)

setDataType

public DefaultEditingServiceParameter setDataType(int dataType)

getDataType

public int getDataType()

Specified by:

getDataType in interface EditingServiceParameter

setAllowNull

public DefaultEditingServiceParameter setAllowNull(boolean allowNull)

getAllowNull

public boolean getAllowNull()

Specified by:

getAllowNull in interface EditingServiceParameter

isValidValue

public boolean isValidValue(java.lang.Object value)

Specified by:

isValidValue in interface EditingServiceParameter

coerceValue

public java.lang.Object coerceValue(java.lang.Object value)

Specified by:

coerceValue in interface EditingServiceParameter