EditableElement.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.sif.edition;

import org.orbisgis.commons.progress.ProgressMonitor;

import java.beans.PropertyChangeListener;

/**
 * Editable elements are used and moved through OrbisGIS GUI views.
 * 
 * This class is created thanks to the NetBeans user interface.
 * Use the "Add property" NetBeans function to add properties easily.
 * See documentation related to java.beans management systems
 */
public interface EditableElement {

        // Properties names
        public static final String PROP_ID = "id";
        public static final String PROP_MODIFIED = "modified";
        public static final String PROP_OPEN= "open";


        /**
         * Add a property-change listener for all properties.
         * The listener is called for all properties.
         * @param listener The PropertyChangeListener instance
         * @note Use EventHandler.create to build the PropertyChangeListener instance
         */
        public void addPropertyChangeListener(PropertyChangeListener listener);

        /**
         * Add a property-change listener for a specific property.
         * The listener is called only when there is a change to
         * the specified property.
         * @param prop The static property name PROP_..
         * @param listener The PropertyChangeListener instance
         * @note Use EventHandler.create to build the PropertyChangeListener instance
         */
        public void addPropertyChangeListener(String prop,PropertyChangeListener listener);

        /**
         * Remove the specified listener from the list
         * @param listener The listener instance
         */
        public void removePropertyChangeListener(PropertyChangeListener listener);

        /**
         * Remove the specified listener for a specified property from the list
         * @param prop The static property name PROP_..
         * @param listener The listener instance
         */
        public void removePropertyChangeListener(String prop,PropertyChangeListener listener);

        /**
         * Return the Id of this element (instance).
         *
         * @return the value of id
         */
        String getId();

        /**
         * Get the state of the editable element
         *
         * @return True if this element was modified since the last time save
         * or open was called
         */
        boolean isModified();

        /**
         * Set the value of modified
         *
         * @param modified new value of modified
         */
        void setModified(boolean modified);

        /**
        * True, if this editable is open by the editor
        * @return the value of open
        */
        boolean isOpen();

        /**
         * Return an unique String that identifies the element type
         *         
         * @return
         */
        String getTypeId();

        /**
         * Opens the element for edition. This method will typically be followed
         * by some edition actions in the stored object, by calls to the save
         * method and finally by a call to close
         *         
         * @param progressMonitor
         * @throws UnsupportedOperationException if this element cannot be
         * edited
         * @throws EditableElementException If the operation cannot be done
         */
        void open(ProgressMonitor progressMonitor)
                throws UnsupportedOperationException, EditableElementException;

        /**
         * Saves the status of the element so that next call to getJAXBElement
         * reflects the changes
         *         
         * @throws UnsupportedOperationException if this element cannot be
         * edited
         * @throws EditableElementException Indicates that the saving was
         * successful but there were some extraordinary conditions during the
         * saving. The saving must always be done
         */
        void save() throws UnsupportedOperationException, EditableElementException;

        /**
         * Closes the element. All resources should be freed and all memory
         * should be released because there may be plenty of
         * GeocognitionElements in closed state
         *         
         * @param progressMonitor
         * @throws UnsupportedOperationException if this element cannot be
         * edited
         * @throws EditableElementException If the closing was not done
         */
        void close(ProgressMonitor progressMonitor)
                throws UnsupportedOperationException, EditableElementException;

        /**
         * Gets the object stored in this element.
         *         
         * @return The object stored in this element or null if the element is
         * not supported
         * @throws UnsupportedOperationException If this element is a folder
         */
        Object getObject() throws UnsupportedOperationException;
}