uk.ac.manchester.cs.owl.explanation.ExplanationProgressPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of explanation-workbench Show documentation
A plug-in that adds explanation facilities to the Protege Desktop ontology editor. Written by Matthew Horridge during his PhD at the University of Manchester.
There is a newer version: 3.0.1
Show newest version
package uk.ac.manchester.cs.owl.explanation;

import org.semanticweb.owl.explanation.api.ExplanationProgressMonitor;
import org.semanticweb.owl.explanation.api.ExplanationGenerator;
import org.semanticweb.owl.explanation.api.Explanation;
import org.semanticweb.owlapi.model.OWLAxiom;
import org.protege.editor.owl.model.OWLWorkspace;

import javax.swing.*;
import java.util.Set;
import java.awt.*;
import java.awt.event.ActionEvent;
/*
 * Copyright (C) 2009, University of Manchester
 *
 * Modifications to the initial code base are copyright of their
 * respective authors, or their employers as appropriate.  Authorship
 * of the modifications may be determined from the ChangeLog placed at
 * the end of this file.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.

 * This library 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
 * Lesser General Public License for more details.

 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/**
 * Author: Matthew Horridge
 * The University of Manchester
 * Information Management Group
 * Date: 14-Oct-2009
 */
public class ExplanationProgressPanel extends JPanel implements ExplanationProgressMonitor {

    private JLabel messageLabel;

    private int numberFound = 0;

    private static final String MESSAGE = "Computing explanations.  Found ";

    private boolean cancelled = false;
    private Action cancelAction;

    /**
     * Creates a new JPanel with a double buffer
     * and a flow layout.
     */
    public ExplanationProgressPanel() {
        setLayout(new BorderLayout(12, 12));
        setBorder(BorderFactory.createEmptyBorder(12, 12, 12, 12));
        setPreferredSize(new Dimension(400, 100));
        JPanel progressPanel = new JPanel(new BorderLayout(3, 3));
        add(progressPanel, BorderLayout.NORTH);
        messageLabel = new JLabel(MESSAGE + "0  ");
        progressPanel.add(messageLabel, BorderLayout.NORTH);
        JProgressBar progressBar = new JProgressBar();
        progressBar.setIndeterminate(true);
        progressPanel.add(progressBar, BorderLayout.SOUTH);
        cancelAction = new AbstractAction("Stop searching") {
            public void actionPerformed(ActionEvent e) {
                cancelled = true;
                setEnabled(false);
            }
        };
        JPanel buttonPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
        add(buttonPanel, BorderLayout.SOUTH);
        buttonPanel.add(new JButton(cancelAction));
    }

    public void reset() {
        cancelled = false;
        numberFound = 0;
        cancelAction.setEnabled(true);
    }

    private void updateMessage() {
        Runnable runnable = new Runnable() {
            public void run() {
                messageLabel.setText(MESSAGE + numberFound);
            }
        };
        if(SwingUtilities.isEventDispatchThread()) {
            runnable.run();
        }
        else {
            SwingUtilities.invokeLater(runnable);
        }
    }

    /**
     * Called by explanation generators that support progress monitors.  This is
     * called when a new explanation is found for an entailment when searching for
     * multiple explanations.
     * @param explanationGenerator            The explanation generator that found the explanation
     * @param explanation          The explanation that was found
     *                             for the entailment or false if the explanation generator should stop finding explanations
     *                             at the next opportunity.
     * @param allFoundExplanations All of the explanations found so far for the specified entailment
     */
    public void foundExplanation(ExplanationGenerator explanationGenerator, Explanation explanation, Set allFoundExplanations) {
        numberFound = allFoundExplanations.size();
        updateMessage();
    }

    /**
     * The explanation generator will periodically check to see if it should continue finding explanations by calling
     * this method.
     * @return true if the explanation generator should cancel the explanation finding process or false
     *         if the explanation generator should continue.
     */
    public boolean isCancelled() {
        return cancelled;
    }

}