Package org.gephi.statistics.plugin

Class Modularity

java.lang.Object

org.gephi.statistics.plugin.Modularity

All Implemented Interfaces:

Statistics, LongTask

public class Modularity
extends Object
implements Statistics, LongTask

Author:

pjmcswee

Field Summary

Fields

Modifier and Type	Field	Description
static String	MODULARITY_CLASS

Constructor Summary

Constructors

Constructor	Description
Modularity()

Method Summary

Modifier and Type	Method	Description
boolean	cancel()	Cancel the task.
void	execute(org.gephi.graph.api.Graph graph)
void	execute(org.gephi.graph.api.GraphModel graphModel)	Executes the statistics algorithm.
int	getInitialModularityClassIndex()
double	getModularity()
boolean	getRandom()
String	getReport()	Returns an HTML string that displays the statistics result.
double	getResolution()
boolean	getUseWeight()
void	setInitialModularityClassIndex(int initialModularityClassIndex)
void	setProgressTicket(ProgressTicket progressTicket)	Set the progress ticket for the long task.
void	setRandom(boolean isRandomized)
void	setResolution(double resolution)
void	setUseWeight(boolean useWeight)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODULARITY_CLASS

public static final String MODULARITY_CLASS

See Also:

Constant Field Values

Constructor Detail

Modularity

public Modularity()

Method Detail

getRandom

public boolean getRandom()

setRandom

public void setRandom(boolean isRandomized)

getUseWeight

public boolean getUseWeight()

setUseWeight

public void setUseWeight(boolean useWeight)

getResolution

public double getResolution()

setResolution

public void setResolution(double resolution)

getInitialModularityClassIndex

public int getInitialModularityClassIndex()

setInitialModularityClassIndex

public void setInitialModularityClassIndex(int initialModularityClassIndex)

cancel

public boolean cancel()

Description copied from interface: LongTask

Cancel the task. Returns true if the task has been successfully cancelled, false otherwise.

Specified by:

cancel in interface LongTask

Returns:

true if the task has been successfully cancelled, false otherwise

setProgressTicket

public void setProgressTicket(ProgressTicket progressTicket)

Description copied from interface: LongTask

Set the progress ticket for the long task. Can't be null.

Specified by:

setProgressTicket in interface LongTask

Parameters:

progressTicket - the progress ticket for this task

execute

public void execute(org.gephi.graph.api.GraphModel graphModel)

Description copied from interface: Statistics

Executes the statistics algorithm.

It is preferable to work on visible graphs, to be synchronized with the visualization.

Specified by:

execute in interface Statistics

Parameters:

graphModel - The graph model

execute

public void execute(org.gephi.graph.api.Graph graph)

getModularity

public double getModularity()

getReport

public String getReport()

Description copied from interface: Statistics

Returns an HTML string that displays the statistics result. Can contains complex HTML snippets and images.

Specified by:

getReport in interface Statistics

Returns:

An HTML string that displays the results for this Statistics