StatisticsModelUI.java

/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian <mathieu.bastian@gephi.org>
Website : http://www.gephi.org

This file is part of Gephi.

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 2011 Gephi Consortium. All rights reserved.

The contents of this file are subject to the terms of either the GNU
General Public License Version 3 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://gephi.org/about/legal/license-notice/
or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the
specific language governing permissions and limitations under the
License.  When distributing the software, include this License Header
Notice in each file and include the License files at
/cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"

If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 3, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 3] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 3 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 3 code and therefore, elected the GPL
Version 3 license, then the option applies only if the new code is
made subject to such option by the copyright holder.

Contributor(s):

Portions Copyrighted 2011 Gephi Consortium.
 */
package org.gephi.desktop.statistics.api;

import javax.swing.event.ChangeListener;
import org.gephi.statistics.spi.Statistics;
import org.gephi.statistics.spi.StatisticsUI;

/**
 *
 * @author Mathieu Bastian
 */
public interface StatisticsModelUI {

    /**
     * Returns the result string for the given <code>StatisticsUI</code> class or
     * <code>null</code> if no result string exists for this statistics.
     * @param statisticsUI      a statisticsUI class
     * @return                  the result or <code>null</code> if not found
     */
    public String getResult(StatisticsUI statisticsUI);

    /**
     * Returns <code>true</code> if the statistics front-end is visible, <code>
     * false</code> otherwise.
     * @param statisticsUI      an UI instance
     * @return                  <code>true</code> if the statistics front-end
     *                          is visible, <code>false</code> otherwise
     */
    public boolean isStatisticsUIVisible(StatisticsUI statisticsUI);

    /**
     * Returns <code>true</code> if the UI is in running state, <code>false</code>
     * otherwise.
     * @param statisticsUI      an UI instance
     * @return                  <code>true</code> if the statistics is running,
     *                          <code>false</code> otherwise
     */
    public boolean isRunning(StatisticsUI statisticsUI);

    /**
     * Returns the <code>Statistics</code> instance currently running for the
     * particular <code>StatisticsUI</code> registered or <code>null</code> if
     * the statistics is not running.
     * @param statisticsUI      an UI instance
     * @return                  the statistics instance if it is running, or
     *                          <code>null</code> if not running
     */
    public Statistics getRunning(StatisticsUI statisticsUI);
    
    /**
     * Returns the report for the given statistics class or <code>null</code> if no report
     * exists for this statistics.
     * @param statistics        a statistics class
     * @return                  the report or <code>null</code> if not found
     */
    public String getReport(Class<? extends Statistics> statistics);

    public void addChangeListener(ChangeListener changeListener);

    public void removeChangeListener(ChangeListener changeListener);
}