| gvSIG desktop 1

package com.iver.cit.gvsig.fmap.edition;

import com.iver.cit.gvsig.fmap.core.IGeometry;

import com.iver.cit.gvsig.fmap.drivers.DriverIOException;

import java.awt.Image;

import java.awt.geom.Rectangle2D;

import java.io.IOException;

/**

 * DOCUMENT ME!

 *

 * @author $author$

 */

public interface EditableFeatureSource {

    /**

     * M?todo invocado cuando se comienza la edici?n, para poner en marcha las

     * estructuras de datos necesarias para la misma, notificar al servidor en

     * protocolos en los que sea necesario, ...

     *

     * @throws EditionException Si no se logra poner la fuente de datos en

     *         edici?n

     */

    void startEdition() throws EditionException;

    /**

     * Invocado cuando termina la edici?n. En funci?n de la clase concreta que

     * implemente este m?todo se generar? el fichero con los resultados de la

     * edici?n, se realizar? una transacci?n a la base de datos, etc.

     *

     * @throws EditionException Si no se consiguen llevar a cabo las

     *         modificaciones

     */

    void stopEdition() throws EditionException;

    /**

     * Cancela la edici?n sin escribir los cambios

     *

     * @throws IOException Si se produce un error

     */

    void cancelEdition() throws IOException;

    /**

     * Si el ?ndice se corresponde a una geometria de las originales de la capa

     * en edici?n y no ha sido modificada ni eliminada devuelve la geometria

     * original. Si ha sido modificada debera de buscar en el fichero de

     * expansi?n y si ha sido eliminada debera devolver null

     *

     * @param index ?ndice de la geometr?a.

     *

     * @return Geometr?a.

     *

     * @throws IOException Si se produce un error con el fichero de expansi?n

     * @throws DriverIOException Si se produce un error accediendo a las

     *         geometr?as originales

     */

    IGeometry getGeometry(int index) throws IOException, DriverIOException;

    /**

     * Devuelve el n?mero de geometrias que hay actualmente en edici?n.

     *

     * @return N?mero de geometr?as.

     *

     * @throws DriverIOException Si se produce un error accediendo a la capa

     */

    int getGeometryCount() throws DriverIOException;

    /**

     * A?ade una geometria al fichero de expansi?n y guarda la correspondencia

     * en una tabla asociada.

     *

     * @param g geometr?a a guardar.

     *

     * @throws DriverIOException Si se produce un error accediendo a las

     *         geometr?as originales

     * @throws IOException Si se produce un error con el fichero de expansi?n

     */

    void addGeometry(IGeometry g) throws DriverIOException, IOException;

    /**

     * Deshace la ?ltima acci?n realizada. Si no hay m?s acciones no realiza

     * ninguna acci?n

     *

     * @throws DriverIOException Si se produce un error accediendo a las

     *         geometr?as originales

     * @throws IOException Si se produce un error con el fichero de expansi?n

     */

    void undo() throws DriverIOException, IOException;

    /**

     * Rehace la ?ltima acci?n deshecha. Si no hay m?s acciones no hace nada

     *

     * @throws DriverIOException Si se produce un error accediendo a las

     *         geometr?as originales

     * @throws IOException Si se produce un error con el fichero de expansi?n

     */

    void redo() throws DriverIOException, IOException;

    /**

     * Devuelve true si se puede deshacer un comando invocando undo o si por el

     * contrario se ha llegado al principio de la lista de comandos y ya no se

     * pueden deshacer m?s comandos

     *

     * @return boolean

     */

    boolean moreUndoCommands();

    /**

     * Devuelve true si se puede rehacer un comando invocando redo o si por el

     * contrario se est? al final de la lista de comandos y ya no se pueden

     * deshacer m?s comandos

     *

     * @return boolean

     */

    boolean moreRedoCommands();

    /**

     * Elimina una geometria. Si es una geometr?a original de la capa en

     * edici?n se marca como eliminada (haya sido modificada o no). Si es una

     * geometr?a a?adida posteriormente se invalida en el fichero de

     * expansi?n, para que una futura compactaci?n termine con ella.

     *

     * @param index ?ndice de la geometr?a que se quiere eliminar

     *

     * @throws DriverIOException Si se produce un error accediendo a las

     *         geometr?as originales

     * @throws IOException Si se produce un error con el fichero de expansi?n

     */

    void removeGeometry(int index) throws DriverIOException, IOException;

    /**

     * Si se intenta modificar una geometr?a original de la capa en edici?n se

     * a?ade al fichero de expansi?n y se registra la posici?n en la que se

     * a?adi?. Si se intenta modificar una geometria que se encuentra en el

     * fichero de expansi?n (por ser nueva o original pero modificada) se

     * invoca el m?todo modifyGeometry y se actualiza el ?ndice de la

     * geometria en el fichero.

     *

     * @param index ?ndice de la geometr?a que se quiere eliminar

     * @param g Geometr?a nueva

     *

     * @throws IOException Si se produce un error con el fichero de expansi?n

     * @throws DriverIOException Si se produce un error accediendo a las

     *         geometr?as originales

     */

    void modifyGeometry(int index, IGeometry g)

        throws IOException, DriverIOException;

    /**

     * Obtiene las geometr?as que se encuentran en el rect?ngulo que se pasa

     * como par?metro haciendo uso del ?ndice espacial

     *

     * @param r Rect?ngulo indicando la porci?n del espacio para el cual se

     *        quiere saber los ?ndices de las geometr?as que se encuentran

     *        dentro de ?l

     *

     * @return Array de ?ndices para su uso con getGeometry, removeGeometry,

     *         ...

     */

    int[] getGeometriesIndexes(Rectangle2D r);

    /**

     * Compacta el almacenamiento de las geometr?as que est?n en edici?n. Tras

     * esta operaci?n, el orden de las geometr?as seguramente cambiar? y toda

     * llamada a getGeometry devolver? una geometr?a distinta de null, ya que

     * las eliminadas son borradas definitivamente. Hay que tener especial

     * cuidado al invocar este m?todo ya que cualquier tipo de asociaci?n

     * entre geometr?as y otro tipo de objetos (comandos de edici?n, snapping,

     * ...) que use el ?ndice de la geometr?a se ver? afectado por ?ste m?todo

     */

    void compact();

    /**

     * Establece la imagen de las geometr?as seleccionadas con el fin de que en

     * una edici?n interactiva se pueda obtener dicha imagen para simular el

     * copiado, rotado, etc

     *

     * @param i imagen

     */

    void setImage(Image i);

    /**

     * Obtiene una imagen con las geometr?as seleccionadas

     *

     * @return imagen

     */

    Image getImage();

    /**

     * DOCUMENT ME!

     */

    void startComplexGeometry();

    /**

     * DOCUMENT ME!

     *

     * @throws IOException DOCUMENT ME!

     * @throws DriverIOException DOCUMENT ME!

     */

    void endComplexGeometry() throws IOException, DriverIOException;

}