EditorFactory.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.sif.docking.DockingPanelLayout;

/**
 * This factory can create an unlimited number of editors.
 * The panels opened by this editor should by retrieved at the next
 * application startup thanks to lightweight custom panel layout
 * Do not keep reference to the created panels, use the {@link EditorManager}
 * getEditors function to retrieve the created panels.
 */
public interface EditorFactory {
 
    /**
     * @return The ID of the factory
     */
    String getId();
    /**
     * Release all resources related to this factory
     */
    void dispose();
    /**
     * Return a layout corresponding to this editable element
     * @param editable editable element
     * @return Instance of DockingPanelLayout or null if the editable
     * is not compatible with this factory
     */
    public DockingPanelLayout makeEditableLayout(EditableElement editable);

    /**
     * Create an empty layout, will be used to apply XML file or a byte stream
     * @return
     */
    public DockingPanelLayout makeEmptyLayout();

    /**
     *
     * @param layout
     * @return True if the layout corresponding to the layout of this factory
     */
    public boolean match(DockingPanelLayout layout);

    /**
     * Return a new DockingPanel for this serialised panel
     * @param layout
     * @return
     */
    public EditorDockable create(DockingPanelLayout layout);

}