org.gvsig.vectorediting.lib.impl

Class DefaultEditingService

java.lang.Object

org.gvsig.tools.service.AbstractService

org.gvsig.vectorediting.lib.impl.DefaultEditingService

All Implemented Interfaces:

Observable, Service, EditingService

public class DefaultEditingService
extends AbstractService
implements EditingService

Field Summary

Fields inherited from interface org.gvsig.vectorediting.lib.api.EditingService

ACTIVATE_NOTIFICATION, FINISH_AND_STORE_NOTIFICATION, FINISH_NOTIFICATION, NEXT_NOTIFICATION, PARAMETER_CHANGED1_NOTIFICATION, PARAMETER_CHANGED2_NOTIFICATION, RESTART_NOTIFICATION, START_NOTIFICATION, STOP_NOTIFICATION

Method Summary

Modifier and Type	Method and Description
void	activate() Activate service
void	addObserver(Observer o)
void	deleteObserver(Observer o)
void	deleteObservers()
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()
Manager	getManager() Returns a reference to the Manager which manages this server.
java.lang.String	getName() Gets service name.
java.util.List<EditingServiceParameter>	getParameters() Gets a List with all parameters of service.
protected EditingProvider	getProvider() Returns the provider related to this service.
protected EditingProviderManager	getProviderManager() Returns the reference to the ProviderManager.
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 class org.gvsig.tools.service.AbstractService

getProviderServices, getServiceParameters, init

Methods inherited from class java.lang.Object

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

Method Detail

getProvider

protected EditingProvider getProvider()

Description copied from class: AbstractService

Returns the provider related to this service.

Overrides:

getProvider in class AbstractService

Returns:

the provider

getManager

public Manager getManager()

Description copied from interface: Service

Returns a reference to the Manager which manages this server.

Specified by:

getManager in interface Service

Returns:

the server's Manager

getDrawingStatus

public DrawingStatus getDrawingStatus(Point mousePosition)
                               throws DrawServiceException

Description copied from interface: EditingService

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.

Specified by:

getDrawingStatus in interface EditingService

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

public java.util.List<EditingServiceParameter> getParameters()

Description copied from interface: EditingService

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

Specified by:

getParameters in interface EditingService

Returns:

A list of EditingServiceParameter objects.

next

public EditingServiceParameter next()

Description copied from interface: EditingService

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

Specified by:

next in interface EditingService

Returns:

An EditingServiceParameter object that represents the next parameter.

setValue

public void setValue(java.lang.Object value)
              throws InvalidEntryException

Description copied from interface: EditingService

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

Specified by:

setValue in interface EditingService

Parameters:

value - Object to be set to next EditingServiceParameter

Throws:

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

stop

public void stop()
          throws StopServiceException

Description copied from interface: EditingService

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

Specified by:

stop in interface EditingService

Throws:

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

finishAndStore

public void finishAndStore()
                    throws FinishServiceException

Description copied from interface: EditingService

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.

Specified by:

finishAndStore in interface EditingService

Throws:

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

finish

public Geometry finish()
                throws FinishServiceException

Description copied from interface: EditingService

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

Specified by:

finish in interface EditingService

Returns:

Geometry created or modified from added values.

Throws:

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

start

public void start()
           throws StartServiceException,
                  InvalidEntryException

Description copied from interface: EditingService

Starts service. Use this method before add values.

Specified by:

start in interface EditingService

Throws:

StartServiceException - if there are some error starting service.

InvalidEntryException - if the entry of provider is not valid

getName

public java.lang.String getName()

Description copied from interface: EditingService

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

Specified by:

getName in interface EditingService

Returns:

Name of service.

setValue

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

Description copied from interface: EditingService

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

Specified by:

setValue in interface EditingService

Parameters:

parameter - EditingServiceParameter

value - Object to be set to EditingServiceParameter

Throws:

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

isEnabled

public boolean isEnabled(EditingServiceParameter parameter)

Description copied from interface: EditingService

Return true if the parameter is enabled

Specified by:

isEnabled in interface EditingService

Returns:

activate

public void activate()

Description copied from interface: EditingService

Activate service

Specified by:

activate in interface EditingService

getValue

public java.lang.Object getValue(EditingServiceParameter parameter)

Description copied from interface: EditingService

Return the parameter's value

Specified by:

getValue in interface EditingService

Returns:

getValue

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

Specified by:

getValue in interface EditingService

addObserver

public void addObserver(Observer o)

Specified by:

addObserver in interface Observable

deleteObserver

public void deleteObserver(Observer o)

Specified by:

deleteObserver in interface Observable

deleteObservers

public void deleteObservers()

Specified by:

deleteObservers in interface Observable

setDefaultFeatureValues

public void setDefaultFeatureValues(EditableFeature feature)

Specified by:

setDefaultFeatureValues in interface EditingService

getDefaultFeatureValues

public EditableFeature getDefaultFeatureValues()

Specified by:

getDefaultFeatureValues in interface EditingService

getStore

public FeatureStore getStore()

Specified by:

getStore in interface EditingService

getLegend

public IVectorLegend getLegend()

Specified by:

getLegend in interface EditingService

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface EditingService

getProviderManager

protected EditingProviderManager getProviderManager()

Description copied from class: AbstractService

Returns the reference to the ProviderManager.

Specified by:

getProviderManager in class AbstractService

Returns:

the ProviderManager

setShowPreviewSymbol

public void setShowPreviewSymbol(boolean showPreviewSymbol)

Specified by:

setShowPreviewSymbol in interface EditingService

restart

public void restart()
             throws StartServiceException,
                    InvalidEntryException,
                    StopServiceException

Specified by:

restart in interface EditingService

Throws:

StartServiceException

InvalidEntryException

StopServiceException

mustRestartAtFinish

public boolean mustRestartAtFinish()

Specified by:

mustRestartAtFinish in interface EditingService