Package org.gephi.statistics.api

Interface StatisticsController

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

Modifier and Type	Method	Description
void	execute(Statistics statistics)	Executes statistics in the current thread.
void	execute(Statistics statistics, LongTaskListener listener)	Execute the statistics algorithm in a background thread and notify listener when finished.
StatisticsBuilder	getBuilder(Class<? extends Statistics> statistics)	Finds the builder from the statistics class.
StatisticsModel	getModel()	Returns the model of the currently selected Workspace.
StatisticsModel	getModel(Workspace workspace)	Returns the model in the given Workspace.

Method Detail

getModel

StatisticsModel getModel()

Returns the model of the currently selected Workspace.

getModel

StatisticsModel getModel(Workspace workspace)

Returns the model in the given Workspace.

Parameters:

workspace - the workspace to lookup

execute

void execute(Statistics statistics,
             LongTaskListener listener)

Execute the statistics algorithm in a background thread and notify listener when finished. The statistics should implement LongTask.

Parameters:

statistics - the statistics algorithm instance

listener - a listener that is notified when execution finished

Throws:

IllegalArgumentException - if statistics doesn't implement LongTask

execute

void execute(Statistics statistics)

Executes statistics in the current thread.

Parameters:

statistics - the statistics to execute

getBuilder

StatisticsBuilder getBuilder(Class<? extends Statistics> statistics)

Finds the builder from the statistics class.

Parameters:

statistics - the statistics class

Returns:

the builder, or null if not found