org.gvsig.vectorediting.lib.prov.spline

Class SplineEditingProvider

java.lang.Object

org.gvsig.tools.service.spi.AbstractProvider

org.gvsig.vectorediting.lib.spi.AbstractEditingProvider

org.gvsig.vectorediting.lib.prov.spline.SplineEditingProvider

All Implemented Interfaces:

Geometry.SUBTYPES, Geometry.TYPES, Provider, EditingProvider

Direct Known Subclasses:

FilledSplineEditingProvider

public class SplineEditingProvider
extends AbstractEditingProvider
implements EditingProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closeSpline
protected FeatureStore	featureStore
protected boolean	finishSpline
protected Map<String,String>	options
protected EditingServiceParameter	points
protected List<Point>	values

Fields inherited from interface org.gvsig.fmap.geom.Geometry.TYPES

AGGREGATE, ARC, CIRCLE, CIRCUMFERENCE, COMPLEX, CURVE, ELLIPSE, ELLIPTICARC, FILLEDSPLINE, GEOMETRY, LINE, MULTICURVE, MULTILINE, MULTIPOINT, MULTIPOLYGON, MULTISOLID, MULTISURFACE, NULL, PERIELLIPSE, POINT, POLYGON, RING, SOLID, SPLINE, SURFACE

Fields inherited from interface org.gvsig.fmap.geom.Geometry.SUBTYPES

GEOM2D, GEOM2DM, GEOM3D, GEOM3DM, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
SplineEditingProvider(ProviderServices services, DynObject parameters) Default constructor.

Method Summary

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

Methods inherited from class org.gvsig.tools.service.spi.AbstractProvider

getProviderServices, setProviderServices

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.tools.service.spi.Provider

setProviderServices

Field Detail

points

protected EditingServiceParameter points

values

protected List<Point> values

options

protected Map<String,String> options

closeSpline

protected boolean closeSpline

finishSpline

protected boolean finishSpline

featureStore

protected FeatureStore featureStore

Constructor Detail

SplineEditingProvider

public SplineEditingProvider(ProviderServices services,
                             DynObject parameters)

Default constructor.

Parameters:

parameters - of service.

providerServices - available services. See EditingProviderServices.

Method Detail

next

public EditingServiceParameter next()

Description copied from interface: EditingProvider

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

Specified by:

next in interface EditingProvider

Returns:

An EditingServiceParameter object that represents the next parameter.

getDrawingStatus

public DrawingStatus getDrawingStatus(Point mousePosition)
                               throws DrawServiceException

Description copied from interface: EditingProvider

Gets state of drawing. If this provider 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 EditingProvider

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.

stop

public void stop()
          throws StopServiceException

Description copied from interface: EditingProvider

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

Specified by:

stop in interface EditingProvider

Throws:

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

getParameters

public List<EditingServiceParameter> getParameters()

Description copied from interface: EditingProvider

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

Specified by:

getParameters in interface EditingProvider

Returns:

A list of EditingServiceParameter objects.

setValue

public void setValue(Object value)
              throws InvalidEntryException

Description copied from interface: EditingProvider

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

Specified by:

setValue in interface EditingProvider

Parameters:

value - Object to be set to next EditingServiceParameter

Throws:

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

finish

public Geometry finish()
                throws FinishServiceException

Description copied from interface: EditingProvider

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

Specified by:

finish in interface EditingProvider

Returns:

Geometry created or modified from added values.

Throws:

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

finishAndStore

public void finishAndStore()
                    throws FinishServiceException

Description copied from interface: EditingProvider

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

Specified by:

finishAndStore in interface EditingProvider

Throws:

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

start

public void start()
           throws StartServiceException

Description copied from interface: EditingProvider

Starts provider. Use this method before add values.

Specified by:

start in interface EditingProvider

Throws:

StartServiceException - if there are some error starting service.

getName

public String getName()

Description copied from interface: EditingProvider

Gets provider name.

Specified by:

getName in interface EditingProvider

Returns:

Name of provider.