Application: gvSIG desktop » gvSIG tools: Vector editing

/*

 * Copyright 2014 DiSiD Technologies S.L.L. All rights reserved.

 *

 * Project  : DiSiD org.gvsig.vectorediting.lib.spi

 * SVN Id   : $Id$

 */

package org.gvsig.vectorediting.lib.spi;

import java.util.List;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.tools.service.spi.Provider;

import org.gvsig.vectorediting.lib.api.DrawingStatus;

import org.gvsig.vectorediting.lib.api.EditingServiceParameter;

import org.gvsig.vectorediting.lib.api.exceptions.DrawServiceException;

import org.gvsig.vectorediting.lib.api.exceptions.FinishServiceException;

import org.gvsig.vectorediting.lib.api.exceptions.InvalidEntryException;

import org.gvsig.vectorediting.lib.api.exceptions.StartServiceException;

import org.gvsig.vectorediting.lib.api.exceptions.StopServiceException;

/**

 * @author gvSIG team.

 */

public interface EditingProvider extends Provider {

  /**

   * Get next parameter needed by service. The parameter has information about

   * its name, description and types. Returns <code>null</code> if all

   * parameters have values.

   * 

   * @return An {@link EditingServiceParameter} object that represents the next

   *         parameter.

   */

  public EditingServiceParameter next();

  /**

   * If provider has sufficient values to draw geometries with mouse position

   * returns a {@link DrawingStatus} object with a collection of geometries and

   * information to draw, otherwise <code>return null</code>. This method is

   * called every time that user moves mouse on <code> MapControl </code>.

   * 

   * @param mousePosition Mouse position to draw geometries.

   * @return A {@link DrawingStatus} object with a list of geometries and

   *         information.

   * @throws DrawServiceException if there are some error creating geometries.

   */

  public DrawingStatus draw(Point mousePosition) throws DrawServiceException;

  /**

   * Stops service initializing necessary parameters of service. This method is

   * called when user cancels service.

   * 

   * @throws StopServiceException Stops service initializing necessary

   *           parameters of service. This method is called when user cancels

   *           service.

   */

  public void stop() throws StopServiceException;

  /**

   * Gets a <code>List</code> with all parameters of service. Each parameter has

   * name, description and types. See {@link EditingServiceParameter}.

   * 

   * @return A list of {@link EditingServiceParameter} objects.

   */

  public List<EditingServiceParameter> getParameters();

  /**

   * Gets the next parameter and set the value received as parameter.

   * 

   * @param value Object to be set to next {@link EditingServiceParameter}

   * @throws InvalidEntryException

   */

  public void value(Object value) throws InvalidEntryException;

  /**

   * Finalizes service. Gets stored values, creates geometries with this values

   * and return geometry created.

   * 

   * @return Geometry created.

   * @throws FinishServiceException if there are some error getting values,

   *           creating geometries or inserting/updating/removing geometries

   *           from feature store.

   */

  public Geometry finish() throws FinishServiceException;

  /**

   * 

   * @throws FinishServiceException

   */

  public void finishAndStore () throws FinishServiceException;

  /**

   * Starts service initializing its parameters.

   * 

   * @throws StartServiceException if there are some error starting service.

   */

  public void start() throws StartServiceException;

  /**

   * Gets service name.

   * 

   * @return Name of service.

   */

  public String getName();

}