org.gvsig.vectorediting.lib.api

Interface EditingService

All Superinterfaces:

Observable, Service

All Known Implementing Classes:

DefaultEditingService

public interface EditingService
extends Service, Observable

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)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVATE_NOTIFICATION
static java.lang.String	FINISH_AND_STORE_NOTIFICATION
static java.lang.String	FINISH_NOTIFICATION
static java.lang.String	NEXT_NOTIFICATION
static java.lang.String	PARAMETER_CHANGED1_NOTIFICATION
static java.lang.String	PARAMETER_CHANGED2_NOTIFICATION
static java.lang.String	RESTART_NOTIFICATION
static java.lang.String	START_NOTIFICATION
static java.lang.String	STOP_NOTIFICATION

Method Summary

Modifier and Type	Method and Description
void	activate() Activate service
Geometry	finish() Finalizes service.
void	finishAndStore() Finalizes service and stores the result to FeatureStore of this service.
EditableFeature	getDefaultFeatureValues()
java.lang.String	getDescription()
DrawingStatus	getDrawingStatus(Point mousePosition) Gets state of drawing.
IVectorLegend	getLegend()
java.lang.String	getName() Gets service name.
java.util.List<EditingServiceParameter>	getParameters() Gets a List with all parameters of service.
FeatureStore	getStore()
java.lang.Object	getValue(EditingServiceParameter parameter) Return the parameter's value
java.lang.Object	getValue(EditingServiceParameter parameter, EditingServiceParameter.TYPE type)
boolean	isEnabled(EditingServiceParameter parameter) Return true if the parameter is enabled
boolean	mustRestartAtFinish()
EditingServiceParameter	next() Gets next parameter needed by service.
void	restart()
void	setDefaultFeatureValues(EditableFeature feature)
void	setShowPreviewSymbol(boolean showPreviewSymbol)
void	setValue(EditingServiceParameter parameter, java.lang.Object value) Sets value into a paremeter of the service.The value will be put in the parameter of this service.
void	setValue(java.lang.Object value) Sets value to service.
void	start() Starts service.
void	stop() Stops service.

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

getManager

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Field Detail

PARAMETER_CHANGED2_NOTIFICATION

static final java.lang.String PARAMETER_CHANGED2_NOTIFICATION

See Also:

Constant Field Values

ACTIVATE_NOTIFICATION

static final java.lang.String ACTIVATE_NOTIFICATION

See Also:

Constant Field Values

NEXT_NOTIFICATION

static final java.lang.String NEXT_NOTIFICATION

See Also:

Constant Field Values

PARAMETER_CHANGED1_NOTIFICATION

static final java.lang.String PARAMETER_CHANGED1_NOTIFICATION

See Also:

Constant Field Values

STOP_NOTIFICATION

static final java.lang.String STOP_NOTIFICATION

See Also:

Constant Field Values

FINISH_AND_STORE_NOTIFICATION

static final java.lang.String FINISH_AND_STORE_NOTIFICATION

See Also:

Constant Field Values

FINISH_NOTIFICATION

static final java.lang.String FINISH_NOTIFICATION

See Also:

Constant Field Values

START_NOTIFICATION

static final java.lang.String START_NOTIFICATION

See Also:

Constant Field Values

RESTART_NOTIFICATION

static final java.lang.String RESTART_NOTIFICATION

See Also:

Constant Field Values

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

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.

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

setValue

void setValue(EditingServiceParameter parameter,
              java.lang.Object value)
       throws InvalidEntryException

Sets value into a paremeter of the service.The value will be put in the parameter of this service.

Parameters:

parameter - EditingServiceParameter

value - Object to be set to EditingServiceParameter

Throws:

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

isEnabled

boolean isEnabled(EditingServiceParameter parameter)

Return true if the parameter is enabled

Parameters:

parameter -

Returns:

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

java.lang.String getName()

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

Returns:

Name of service.

activate

void activate()

Activate service

getValue

java.lang.Object getValue(EditingServiceParameter parameter)

Return the parameter's value

Parameters:

parameter -

Returns:

getValue

java.lang.Object getValue(EditingServiceParameter parameter,
                          EditingServiceParameter.TYPE type)

setDefaultFeatureValues

void setDefaultFeatureValues(EditableFeature feature)

getDefaultFeatureValues

EditableFeature getDefaultFeatureValues()

getStore

FeatureStore getStore()

getLegend

IVectorLegend getLegend()

getDescription

java.lang.String getDescription()

setShowPreviewSymbol

void setShowPreviewSymbol(boolean showPreviewSymbol)

restart

void restart()
      throws StartServiceException,
             InvalidEntryException,
             StopServiceException

Throws:

StartServiceException

InvalidEntryException

StopServiceException

mustRestartAtFinish

boolean mustRestartAtFinish()