/ - Diff - gvSIG tools: Vector editing - gvSIG

Revision 20

     The API will provide the following services:
     * Provide an EditingService for an editing tool.
     * getEditingService( Strin serviceName, FeatureStore featureStore) :: EditingService
       Creates a DynObject with the necessary service parameters, set featureStore value to dynobject and creates an EditingService.
     * Provide information of an editing tool:: EditingServiceInfo
     * getServiceInfo(String serviceName) :: EditingServiceInfo
       Provides information of an editing tool
     * activateTool(String name, MapControl mapControl) :: void
       If mapControl has EditingBehavior added as tool, this method calls activateTool of EditingBehavior.
     EditingService (extends Service)
     *****************************************************
     * Start the edition.
     At this moment delagates all functionality to providers.
     * Provide the following parameter required by the tool
     * start() :: void
     * getNextParameter() :: EditingServiceParameter
     * setValueParameter(EditingServiceParameter param, Object value) :: void
     * drawOperation(Point mousePosition) :: Geometry
     * stop() :: void
     * Set<EditingServiceParameter> getParameters() :: Set<EditingServiceParameter
     * void finishOperation(MapControl mapcontrol);
     * isValidvalue(EditingServiceParameter param, Object value);
     * Set the current parameter value.
     * Provide a Geometry to draw the current editing context, taking into account the values previously provided by the user and a Point with the current mouse cursor location.
     * Cancel the execution of the tool.
     * ?Ask for the Geometries or Features created, updated or removed by the tool?
     EditingServiceInfo
     *****************************************************
     * Provide read only information about a tool:
       * Tool name.
       * Tool description (?use as contextual help?)
       * Mouse icon.
       * The geometry type being managed.
       * If the tool creates new geometries.
       * The list of the parameters.
     * Provide read only information about a tool parameter :: EditingServiceParameter
       * Tool name getName :: String
       * Tool description (?use as contextual help?) getDescription :: String
       * Mouse icon. getMouseIcon() :: Image
       * The geometry type being managed. getSupportedPrimitiveGeometryType() :: int
       * If the tool creates new geometries. createsNewGeometries() :: boolean
       * The list of the parameters. getParameters() :: List<EditingServiceParameter>
     * getParameterInfo(String name) :: EditingServiceParameter
       Provide read only information about a tool parameter :: EditingServiceParameter
     EditingServiceParameter
     *****************************************************
     * Provide read only information about a parameter:
       * Parameter name.
       * Parameter name. getName() :: String
       * Parameter description (?use as contextual help?)
       * Parameter description (?use as contextual help?) getDescription :: String
       * Parameter type:
       * Parameter type: There are 6 types of parameters: point, list of points, option, value, selection and geometry. None typed, EditingService
         checks if the parameter value is correct before put it at colection values.
         * Location Point
         * List of Location Points
         * Option
         * Value (*?typed value: string, integer, ...?*)
         * New Geometry of a given type.
         * Selection of one or many geometries/features.
       * equals(EditingServiceParameter param) :: boolean
         Compares two parameters.
     EditingBehavior
     *****************************************************
     * activateTool(String name);
       Activates tool creating an EditingService and ask for the next parameter.
     SPI
     -----
     * Project: org.gvsig.vectorediting/org.gvsig.vectorediting.lib/org.gvsig.vectorediting.lib.spi
     * Package: or.gvsig.vectorediting.lib.spi
     EditingServiceManager (extends ProviderManager)
     EditingpProviderManager (extends ProviderManager)
     *****************************************************
     * Registration of editing tools :: EditingProviderFactory.
     * No methods.
     EditingProviderServices (extends ProviderServices)
     *****************************************************
     * Store a new or updated Feature.
     * Methods to create features / geometries.
     * Delete a Feature.
       * createFeature (Feature feature, FeatureStore featureStore)
       * createGeometry(Geometry geometry, FeatureStore featureStore)
       * createGeometryAndSelect(Geometry geometry, FeatureStore featureStore)
     * Methods to delete features / geometries.
       * deleteFeature(Feature feature, FeatureStore featureStore)
       * deleteGeometry(Geometry geometry, FeatureStore featureStore)
     * Methods to update features / geometries
       * updateFeature(Feature feature, FeatureStore featureStore)
       * updateGeometry(Geometry geometry, FeatureStore featureStore)
       * updateGeometryAndSelect(Geometry geometry, FeatureStore featureStore)
     * ?Get the Symbol to draw a Geometry?.
     * Create new Features based on another ones, following the common criteria about the alphanumeric information:
       * New Features created from an old one (ex: Split): clone all data, but the primary keys.
       * New Feature created from a set of Features (ex: Union): for every attribute, if the values are the same for all the source Features, ignoring null values, clone it. Otherwise leave as null.
     .. admonition:: Note
        There is no methods to this.
     DefaultEditingServiceInfo and DefaultEditingServiceParameter
     **************************************************************
-...
     EditingProviderFactory (ProviderFactory)
     *****************************************************
     * Provide information of the tool (see EditingManager's API).
     * getServiceInfo() :: EditingServiceInfo
       Provide information of the tool (see EditingManager's API).
     * Provide information of a tool parameter (see EditingManager's API).
     * getServiceParameterInfo() :: EditingServiceParameter
       Provide information of a tool parameter (see EditingManager's API).
     EditingProvider (Provider)
     *****************************************************
     * Provide the following parameter.
     * Provide a Geometry to draw the current editing context (see EditingService's API).
     * End the editing process and store changes.
     * Cancel the editing process and discard changes.
     * start() :: void
       Starts service, initializing attibrutes.
     * getNextParameter() :: EditingServiceParameter
       Returns the next parameter required by the tool. If all parameters have values return null.
     * setValueParameter(EditingServiceParameter param, Object value) :: void
       Sets parameter value whit it param.
     * drawOperation(Point mousePosition) :: Geometry
       Provides a Geometry to draw the current editing context, taking into account the values previously provided by the user and a Point with the
       current mouse cursor location.
     * stop() :: void
       Cancels the execution of the tool.
     * Set<EditingServiceParameter> getParameters() :: Set<EditingServiceParameter
       Returns a set with all parameters required by the tool
     * finishOperation(MapControl mapcontrol) :: void
       Indicates that the tool doesn't need more values.
     * isValidValue(EditingServiceParameter param, Object value) :: boolean
       Check if the value is valid for the param received.
     .. admonition:: Doubt
        Not sure if return a Set or a List.
     * ?Ask for the Geometries or Features created, updated or removed by the tool?
     .. admonition:: Doubt
        Not sure if this is neccessary. At this moment there is no methods to this.
     AbstractEditingProvider extends AbstractProvider implements EditingProvider
     ****************************************************************************
     Implements all creation common operations of providers such as createPoint, createCurve, createMultiCurve, createArc, createCircle...
     Implementation
     ----------------
-...
     EditingExtension
     *****************************************************
     Registers the EditingBehavior in MapContext, as well as the actions to activate/deactivate editing.
     Also activates the console when editing is started, puts the selected layer store in editing mode, and notifies about the begin and end of editing mode.
     EditingBehavior
     *****************************************************
     Implementation of Behavior which interacts with the editing tools.
     .. admonition:: Doubt
        ?Create instead as an interface in the API, and create a default implementation in the library implementation?
     BaseEditingServiceExtension
     *****************************************************
     Default implementation to be used by editing tool plugins.
     Default implementation to be used by editing tool plugins. Maybe BaseEditingServiceExtension implements execute action (activateTool) and each tool implements if it is enable or not.
     .. admonition:: Doubt

Also available in: Unified diff

Application: gvSIG desktop » gvSIG tools: Vector editing

Revision 20