org.gvsig.vectorediting.lib.api

Interface EditingService

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultEditingService

public interface EditingService
extends Service

This service is used to interact with Editing providers. Each instance of this has linked an Editing provider. At this moment services delegate all functionality to providers. To get an instance of this use EditingManager#getEditingService(String, org.gvsig.fmap.dal.feature.FeatureStore)

Method Summary

Modifier and Type	Method and Description
Geometry	finish() Finalizes service.
void	finishAndStore() Finalizes service and stores the result to FeatureStore of this service.
DrawingStatus	getDrawingStatus(Point mousePosition) Gets state of drawing.
String	getName() Gets service name.
List<EditingServiceParameter>	getParameters() Gets a List with all parameters of service.
EditingServiceParameter	next() Gets next parameter needed by service.
void	setValue(Object value) Sets value to service.
void	start() Starts service.
void	stop() Stops service.

Methods inherited from interface org.gvsig.tools.service.Service

getManager

Method Detail

getDrawingStatus

DrawingStatus getDrawingStatus(Point mousePosition)
                        throws DrawServiceException

Gets state of drawing. If this service has sufficient values with mouse position to create geometries returns a DrawingStatus. List of geometries of drawing status object can be different from final geometries. Use this method to get a draft status information while user is drawing.

Parameters:

mousePosition - Mouse position to draw geometries.

Returns:

A DrawingStatus object with a list of geometries and information.

Throws:

DrawServiceException - if there are some error creating geometries.

getParameters

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.

next

EditingServiceParameter next()

Gets next parameter needed by service. The parameter has information about its name, description and types. Returns null if all parameters have values.

Returns:

An EditingServiceParameter object that represents the next parameter.

setValue

void setValue(Object value)
       throws InvalidEntryException

Sets value to service. The value will be put in the next parameter need by this service.

Parameters:

value - Object to be set to next EditingServiceParameter

Throws:

InvalidEntryException - If the next parameter needed does not accept this value.

stop

void stop()
   throws StopServiceException

Stops service. Use this method to stop and clean values of service.

Throws:

StopServiceException - Stops service initializing necessary parameters of service. This method is called when user cancels service.

finish

Geometry finish()
         throws FinishServiceException

Finalizes service. Use this method to get the result of service without store it to FeatureStore. Make sure that service has all required values.

Returns:

Geometry created or modified from added values.

Throws:

FinishServiceException - if there are some error getting values, creating geometries.

finishAndStore

void finishAndStore()
             throws FinishServiceException

Finalizes service and stores the result to FeatureStore of this service. Use this method to store the result of this service. Make sure that service has all required values.

Throws:

FinishServiceException - if there are some error getting values, creating geometries or inserting/updating/removing geometries from feature store.

start

void start()
    throws StartServiceException,
           InvalidEntryException

Starts service. Use this method before add values.

Throws:

StartServiceException - if there are some error starting service.

InvalidEntryException - if the entry of provider is not valid

getName

String getName()

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

Returns:

Name of service.