Gephi Toolkit Javadoc

org.gephi.statistics.api
Interface StatisticsController

All Known Implementing Classes:
StatisticsControllerImpl

public interface StatisticsController

Controller for executing Statistics/Metrics algorithms.

This controller is a service and can therefore be found in Lookup:

StatisticsController sc = Lookup.getDefault().lookup(StatisticsController.class);

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

Method Summary
 void execute(Statistics statistics, LongTaskListener listener)
          Execute the statistics algorithm.
 StatisticsBuilder getBuilder(java.lang.Class<? extends Statistics> statistics)
          Finds the builder from the statistics class.
 StatisticsModel getModel()
          Returns the current StatisticsModel, from the current workspace
 void setStatisticsUIVisible(StatisticsUI ui, boolean visible)
          Sets the visible state for a given StatisticsUI.
 

Method Detail

execute

void execute(Statistics statistics,
             LongTaskListener listener)
Execute the statistics algorithm. If statistics implements LongTask, execution is performed in a background thread and therefore this method returns immedialtely.

Parameters:
statistics - the statistics algorithm instance
listener - a listener that is notified when execution finished

getBuilder

StatisticsBuilder getBuilder(java.lang.Class<? extends Statistics> statistics)
Finds the builder from the statistics class.

Parameters:
statistics - the statistics class
Returns:
the builder, or null if not found

setStatisticsUIVisible

void setStatisticsUIVisible(StatisticsUI ui,
                            boolean visible)
Sets the visible state for a given StatisticsUI.

Parameters:
ui - the UI instance
visible - true to display the front-end

getModel

StatisticsModel getModel()
Returns the current StatisticsModel, from the current workspace

Returns:
the current StatisticsModel

Gephi Toolkit Javadoc