Gephi Toolkit Javadoc

org.gephi.statistics.plugin
Class Modularity

java.lang.Object
  extended by org.gephi.statistics.plugin.Modularity
All Implemented Interfaces:
Statistics, LongTask

public class Modularity
extends java.lang.Object
implements Statistics, LongTask

Author:
pjmcswee

Field Summary
static java.lang.String MODULARITY_CLASS
           
 
Constructor Summary
Modularity()
           
 
Method Summary
 boolean cancel()
          Cancel the task.
 void execute(GraphModel graphModel, AttributeModel attributeModel)
          Executes the statistics algorithm.
 void execute(HierarchicalUndirectedGraph hgraph, AttributeModel attributeModel)
           
 double getModularity()
           
 boolean getRandom()
           
 java.lang.String getReport()
          Returns an HTML string that displays the statistics result.
 double getResolution()
           
 boolean getUseWeight()
           
 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODULARITY_CLASS

public static final java.lang.String MODULARITY_CLASS
See Also:
Constant Field Values
Constructor Detail

Modularity

public Modularity()
Method Detail

setRandom

public void setRandom(boolean isRandomized)

getRandom

public boolean getRandom()

setUseWeight

public void setUseWeight(boolean useWeight)

getUseWeight

public boolean getUseWeight()

setResolution

public void setResolution(double resolution)

getResolution

public double getResolution()

cancel

public boolean cancel()
Description copied from interface: LongTask
Cancel the task. Returns true if the task has been sucessfully cancelled, false otherwise.

Specified by:
cancel in interface LongTask
Returns:
true if the task has been sucessfully 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(GraphModel graphModel,
                    AttributeModel attributeModel)
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 topology
attributeModel - The elements attributes, and where to write table results

execute

public void execute(HierarchicalUndirectedGraph hgraph,
                    AttributeModel attributeModel)

getModularity

public double getModularity()

getReport

public java.lang.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

Gephi Toolkit Javadoc