EditorPanelTracker.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.docking.impl.edition;

import org.orbisgis.sif.edition.EditorDockable;
import org.orbisgis.sif.edition.EditorManager;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceReference;
import org.osgi.util.tracker.ServiceTracker;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.swing.SwingUtilities;

/**
 * Show {@link EditorDockable} registered services.
 * When a bundle register the Service {@link EditorDockable}, this tracker catch the event
 * and register the provided {@link EditorDockable} instance to the {@link EditorManagerImpl}.
 * @author Nicolas Fortin
 */
public class EditorPanelTracker extends ServiceTracker<EditorDockable, EditorDockable> {
    private static enum DP_EVT { ADDED, MODIFIED, REMOVED}
    private BundleContext hostContext;
    private EditorManager editorManager;
    private static final Logger LOGGER = LoggerFactory.getLogger(EditorPanelTracker.class);
    /**
     * Constructor.
     * @param context Bundle context
     * @param editorManager Docking manager
     */
    public EditorPanelTracker(BundleContext context, EditorManager editorManager) {
        super(context, EditorDockable.class, null);
        hostContext = context;
        this.editorManager = editorManager;
    }
    @Override
    public EditorDockable addingService(ServiceReference<EditorDockable> reference) {
        EditorDockable editorDockable = hostContext.getService(reference);
        processOperation(new DockingPanelOperation(editorManager,editorDockable, DP_EVT.ADDED));
        return editorDockable;
    }
    @Override
    public void modifiedService(ServiceReference<EditorDockable> reference, EditorDockable editorDockable) {
    }
    @Override
    public void removedService(ServiceReference<EditorDockable> reference, EditorDockable editorDockable) {
        processOperation(new DockingPanelOperation(editorManager,editorDockable, DP_EVT.REMOVED));
    }

    private void processOperation(DockingPanelOperation operation) {
            SwingUtilities.invokeLater(operation);
    }

    /**
     * Guaranty that the Add/Remove panel operation is done on swing thread.
     */
    private static class DockingPanelOperation implements Runnable {
        private EditorManager editorManager;
        private EditorDockable editor;
        private DP_EVT operation;

        private DockingPanelOperation(EditorManager editorManager, EditorDockable editor, DP_EVT operation) {
            this.editorManager = editorManager;
            this.editor = editor;
            this.operation = operation;
        }

        @Override
        public void run() {
            switch(operation) {
                case REMOVED:
                    editorManager.removeEditor(editor);
                    break;
                case ADDED:
                    editorManager.addEditor(editor);
                    break;
            }
        }
    }
}