TableUndoableEdit.java

/**
 * OrbisGIS is a java GIS application dedicated to research in GIScience.
 * OrbisGIS is developed by the GIS group of the DECIDE team of the 
 * Lab-STICC CNRS laboratory, see <http://www.lab-sticc.fr/>.
 *
 * The GIS group of the DECIDE team is located at :
 *
 * Laboratoire Lab-STICC – CNRS UMR 6285
 * Equipe DECIDE
 * UNIVERSITÉ DE BRETAGNE-SUD
 * Institut Universitaire de Technologie de Vannes
 * 8, Rue Montaigne - BP 561 56017 Vannes Cedex
 * 
 * OrbisGIS is distributed under GPL 3 license.
 *
 * Copyright (C) 2007-2014 CNRS (IRSTV FR CNRS 2488)
 * Copyright (C) 2015-2017 CNRS (Lab-STICC UMR CNRS 6285)
 *
 * This file is part of OrbisGIS.
 *
 * OrbisGIS is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * OrbisGIS is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * OrbisGIS. If not, see <http://www.gnu.org/licenses/>.
 *
 * For more information, please consult: <http://www.orbisgis.org/>
 * or contact directly:
 * info_at_ orbisgis.org
 */
package org.orbisgis.corejdbc;

import java.sql.SQLException;

/**
 * A table edit that can be undone.
 * The interface {@link javax.swing.undo.UndoableEdit} is not used because {@link javax.swing.undo.CannotUndoException} can not embed another exception.
 * @author Nicolas Fortin
 */
public interface TableUndoableEdit {
    /**
     * Run SQL commands in order to undo changes.
     * @throws java.sql.SQLException If an error occurred while undoing
     */
    public void undo() throws SQLException;

    /**
     * @return true if SQL commands are available in order to undo the changes.
     */
    public boolean canUndo();

    /**
     * Re-applies the SQL commands in order to redo changes.
     *
     * @throws java.sql.SQLException If an error occurred while redoing
     */
    public void redo() throws SQLException;

    /**
     * @return true if SQL commands are available in order to redo changes.
     */
    public boolean canRedo();

    /**
     * Informs the edit that it should no longer be used. Free stored SQL commands. Undo/Redo are no longer applicable.
     */
    public void die();

    /**
     * @return true if an undo task should stop to this undoable edit.
     */
    public boolean isSignificant();

    /**
     * @return Edit identifier for this category of edit.
     */
    public String getEditIdentifier();

    /**
     * @return Localized message associated with this edit.
     */
    public String getPresentationName();

    /**
     * @return Localized message associated with this edit undo task.
     */
    public String getUndoPresentationName();

    /**
     * @return Localized message associated with this edit redo task.
     */
    public String getRedoPresentationName();
}