org.gvsig.vectorediting.lib.prov.polyline

Class PolylineEditingProvider

java.lang.Object

org.gvsig.tools.service.spi.AbstractProvider

org.gvsig.vectorediting.lib.spi.AbstractEditingProvider

org.gvsig.vectorediting.lib.prov.polyline.PolylineEditingProvider

All Implemented Interfaces:

Geometry.SUBTYPES, Geometry.TYPES, Provider, EditingProvider

Direct Known Subclasses:

PolygonEditingProvider

public class PolylineEditingProvider
extends AbstractEditingProvider
implements EditingProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARC_MODE
static java.lang.String	CLOSE_POLYLINE
protected EditingProviderServices	editingProviderServices
protected FeatureStore	featureStore
static java.lang.String	FINISH
static java.lang.String	KEY_ARC_MODE
static java.lang.String	KEY_CLOSE
static java.lang.String	KEY_FINISH
static java.lang.String	KEY_LINE_MODE
static java.lang.String	KEY_REMOVE_LAST_POINT
static java.lang.String	LINE_MODE
protected EditingServiceParameter	points
static java.lang.String	REMOVE_LAST_POINT

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, UNKNOWN

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

GEOM2D, GEOM2DM, GEOM3D, GEOM3DM, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
PolylineEditingProvider(ProviderServices providerServices, DynObject parameters)

Method Summary

Modifier and Type	Method and Description
protected Line	calculatePolyline(Point lastPosition) Calculates polyline with stored values and last position received as parameter.If last position is null calculates only with stored values.
protected Line	calculatePolyline(Point lastPosition, DefaultDrawingStatus drawingStatus)
protected Geometry	closeGeometryIfNecessary(Geometry geometry)
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.
java.lang.String	getName() Gets provider name.
java.util.List<EditingServiceParameter>	getParameters() Gets a List with all parameters of provider.
java.lang.Object	getValue(EditingServiceParameter parameter) Return parameter's value
EditingServiceParameter	next() Gets next parameter needed by provider.
void	setValue(EditingServiceParameter parameter, java.lang.Object value) Sets value into a paremeter of the provider.The value will be put in the parameter of this provider.
void	setValue(java.lang.Object value) Sets value to provider.
void	start() Starts provider.
void	stop() Stops provider.

Methods inherited from class org.gvsig.vectorediting.lib.spi.AbstractEditingProvider

activate, getDefaultFeatureValues, getPreviewSymbol, getPreviewSymbol, getProviderServices, getSelectedFeaturesCopy, getValue, initDefaultValues, isEnabled, isShowPreviewSymbol, makeMultiPrimitiveIsNeeded, mustRestartAtFinish, restart, setDefaultFeatureValues, setShowPreviewSymbol

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

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.vectorediting.lib.spi.EditingProvider

activate, getDefaultFeatureValues, getValue, initDefaultValues, isEnabled, isShowPreviewSymbol, mustRestartAtFinish, restart, setDefaultFeatureValues, setShowPreviewSymbol

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

setProviderServices

Field Detail

KEY_REMOVE_LAST_POINT

public static final java.lang.String KEY_REMOVE_LAST_POINT

See Also:

Constant Field Values

KEY_FINISH

public static final java.lang.String KEY_FINISH

See Also:

Constant Field Values

KEY_CLOSE

public static final java.lang.String KEY_CLOSE

See Also:

Constant Field Values

KEY_LINE_MODE

public static final java.lang.String KEY_LINE_MODE

See Also:

Constant Field Values

KEY_ARC_MODE

public static final java.lang.String KEY_ARC_MODE

See Also:

Constant Field Values

REMOVE_LAST_POINT

public static final java.lang.String REMOVE_LAST_POINT

See Also:

Constant Field Values

FINISH

public static final java.lang.String FINISH

See Also:

Constant Field Values

CLOSE_POLYLINE

public static final java.lang.String CLOSE_POLYLINE

See Also:

Constant Field Values

LINE_MODE

public static final java.lang.String LINE_MODE

See Also:

Constant Field Values

ARC_MODE

public static final java.lang.String ARC_MODE

See Also:

Constant Field Values

editingProviderServices

protected EditingProviderServices editingProviderServices

points

protected EditingServiceParameter points

featureStore

protected FeatureStore featureStore

Constructor Detail

PolylineEditingProvider

public PolylineEditingProvider(ProviderServices providerServices,
                               DynObject parameters)

Method Detail

calculatePolyline

protected Line calculatePolyline(Point lastPosition)
                          throws VectorEditingException,
                                 CreateGeometryException,
                                 DataException

Calculates polyline with stored values and last position received as parameter.If last position is null calculates only with stored values.

Parameters:

lastPosition - of polyline.

Returns:

A drawing status value with a list of geometries. See DrawingStatus.getGeometries().

Throws:

VectorEditingException

CreateGeometryException

DataException

calculatePolyline

protected Line calculatePolyline(Point lastPosition,
                                 DefaultDrawingStatus drawingStatus)
                          throws VectorEditingException,
                                 CreateGeometryException,
                                 DataException

Throws:

VectorEditingException

CreateGeometryException

DataException

closeGeometryIfNecessary

protected Geometry closeGeometryIfNecessary(Geometry geometry)

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.

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.

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.

getName

public java.lang.String getName()

Description copied from interface: EditingProvider

Gets provider name.

Specified by:

getName in interface EditingProvider

Returns:

Name of provider.

getParameters

public java.util.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.

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.

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.

stop

public void stop()

Description copied from interface: EditingProvider

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

Specified by:

stop in interface EditingProvider

setValue

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

Description copied from interface: EditingProvider

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

Specified by:

setValue in interface EditingProvider

Specified by:

setValue in class AbstractEditingProvider

Parameters:

parameter - EditingServiceParameter

value - Object to be set to EditingServiceParameter

Throws:

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

setValue

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

getValue

public java.lang.Object getValue(EditingServiceParameter parameter)

Description copied from interface: EditingProvider

Return parameter's value

Specified by:

getValue in interface EditingProvider

Overrides:

getValue in class AbstractEditingProvider

Returns: