org.gvsig.vectorediting.lib.api

Interface EditingServiceParameter

All Known Implementing Classes:

DefaultEditingServiceParameter

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EditingServiceParameter.TYPE TYPE represents the available type of parameters.

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)
void	setDefaultValue(java.lang.Object value) Sets the default value of this parameter.
void	setDescription(java.lang.String newDescription) Sets the description.

Method Detail

getTypes

java.util.Set<EditingServiceParameter.TYPE> getTypes()

Gets types of this parameter.

Returns:

A Set of parameter types.

getName

java.lang.String getName()

Gets a name of parameter.

Returns:

Parameter name

getDescription

java.lang.String getDescription()

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

Returns:

Description parameter.

setDescription

void setDescription(java.lang.String newDescription)

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

Parameters:

newDescription -

getDefaultValue

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

Sets the default value of this parameter.

Parameters:

value -

getConsoleDefaultValue

java.lang.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

java.util.Map<java.lang.String,java.lang.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(java.lang.Object value)

coerceValue

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

getAllowNull

boolean getAllowNull()