Gephi Toolkit Javadoc

org.gephi.statistics.api
Interface StatisticsModel

All Known Implementing Classes:
StatisticsModelImpl

public interface StatisticsModel

Hosts user interface states and statistics instances, to have access to results strings.

Author:
Patrick J. McSweeney, Mathieu Bastian
See Also:
StatisticsController

Method Summary
 void addChangeListener(javax.swing.event.ChangeListener changeListener)
           
 java.lang.String getReport(java.lang.Class<? extends Statistics> statistics)
          Returns the report for the given statistics class or null if no report exists for this statistics.
 java.lang.String getResult(StatisticsUI statisticsUI)
          Returns the result string for the given StatisticsUI class or null if no result string exists for this statistics.
 Statistics getRunning(StatisticsUI statisticsUI)
          Returns the Statistics instance currently running for the particular StatisticsUI registered or null if the statistics is not running.
 boolean isRunning(StatisticsUI statisticsUI)
          Returns true if the UI is in running state, false otherwise.
 boolean isStatisticsUIVisible(StatisticsUI statisticsUI)
          Returns true if the statistics front-end is visible, false otherwise.
 void removeChangeListener(javax.swing.event.ChangeListener changeListener)
           
 

Method Detail

getReport

java.lang.String getReport(java.lang.Class<? extends Statistics> statistics)
Returns the report for the given statistics class or null if no report exists for this statistics.

Parameters:
statistics - a statistics class
Returns:
the report or null if not found

getResult

java.lang.String getResult(StatisticsUI statisticsUI)
Returns the result string for the given StatisticsUI class or null if no result string exists for this statistics.

Parameters:
statisticsUI - a statisticsUI class
Returns:
the result or null if not found

isStatisticsUIVisible

boolean isStatisticsUIVisible(StatisticsUI statisticsUI)
Returns true if the statistics front-end is visible, false otherwise.

Parameters:
statisticsUI - an UI instance
Returns:
true if the statistics front-end is visible, false otherwise

isRunning

boolean isRunning(StatisticsUI statisticsUI)
Returns true if the UI is in running state, false otherwise.

Parameters:
statisticsUI - an UI instance
Returns:
true if the statistics is running, false otherwise

getRunning

Statistics getRunning(StatisticsUI statisticsUI)
Returns the Statistics instance currently running for the particular StatisticsUI registered or null if the statistics is not running.

Parameters:
statisticsUI - an UI instance
Returns:
the statistics instance if it is running, or null if not running

addChangeListener

void addChangeListener(javax.swing.event.ChangeListener changeListener)

removeChangeListener

void removeChangeListener(javax.swing.event.ChangeListener changeListener)

Gephi Toolkit Javadoc