org.gvsig.vectorediting.lib.api

Interface EditingServiceInfo

All Known Implementing Classes:

DefaultEditingServiceinfo

public interface EditingServiceInfo

Editing service represents the available read-only information about a service. This information is composed by type (creates geometries or not), mouse icon, list of parameters, supported geometries, description, name, information of parameters, and compatibility with GeometryType.

Method Summary

Modifier and Type	Method and Description
boolean	createsNewGeometries() Returns if service creates new geometries.
java.lang.String	getDescription() Gets description of service.
java.awt.Image	getMouseIcon() Get mouse icon associated to service.
java.lang.String	getName() Gets name of service.
EditingServiceParameter	getParameterInfo(java.lang.String name) Gets read only information about a parameter of this service.
java.util.List<EditingServiceParameter>	getParameters() Gets a List with all parameters of service.
int[]	getSupportedPrimitiveGeometryTypes() Gets supported primitive geometry types of service.
boolean	isCompatibleWith(GeometryType geoType) Returns if service is compatible with the geometry type received as parameter.

Method Detail

createsNewGeometries

boolean createsNewGeometries()

Returns if service creates new geometries.

Returns:

true if service creates new geometries otherwise false.

getMouseIcon

java.awt.Image getMouseIcon()

Get mouse icon associated to service.

Returns:

Image that represents mouse icon.

getParameters

java.util.List<EditingServiceParameter> getParameters()

Gets a List with all parameters of service. Each parameter has name, description and types. See EditingServiceParameter.

Returns:

A list of EditingServiceParameter objects.

getSupportedPrimitiveGeometryTypes

int[] getSupportedPrimitiveGeometryTypes()

Gets supported primitive geometry types of service. Primitive types must be Geometry.TYPES.

Returns:

An array whit primitive type supported

getDescription

java.lang.String getDescription()

Gets description of service.

Returns:

Description of service.

getName

java.lang.String getName()

Gets name of service. The name of service is the same name of linked provider name.

Returns:

service name.

getParameterInfo

EditingServiceParameter getParameterInfo(java.lang.String name)

Gets read only information about a parameter of this service. See EditingServiceParameter.

Parameters:

name - Name of parameter.

Returns:

An EditingServiceParameter object of parameter.

isCompatibleWith

boolean isCompatibleWith(GeometryType geoType)
                  throws ServiceInformationException

Returns if service is compatible with the geometry type received as parameter.

Parameters:

geoType - see GeometryType

Returns:

True if service is compatible otherwise false.

Throws:

ServiceInformationException