Gephi Toolkit Javadoc

org.gephi.statistics.plugin
Class GraphDistance

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

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

Ref: Ulrik Brandes, A Faster Algorithm for Betweenness Centrality, in Journal of Mathematical Sociology 25(2):163-177, (2001)

Author:
pjmcswee

Field Summary
static java.lang.String BETWEENNESS
           
static java.lang.String CLOSENESS
           
static java.lang.String ECCENTRICITY
           
 
Constructor Summary
GraphDistance()
           
 
Method Summary
 boolean cancel()
          Cancel the task.
 void execute(GraphModel graphModel, AttributeModel attributeModel)
          Executes the statistics algorithm.
 void execute(HierarchicalGraph hgraph, AttributeModel attributeModel)
           
 double getDiameter()
           
 double getPathLength()
           
 java.lang.String getReport()
          Returns an HTML string that displays the statistics result.
 boolean isDirected()
           
 boolean isNormalized()
           
 void setDirected(boolean isDirected)
           
 void setNormalized(boolean isNormalized)
           
 void setProgressTicket(ProgressTicket progressTicket)
          Set the progress ticket for the long task.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BETWEENNESS

public static final java.lang.String BETWEENNESS
See Also:
Constant Field Values

CLOSENESS

public static final java.lang.String CLOSENESS
See Also:
Constant Field Values

ECCENTRICITY

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

GraphDistance

public GraphDistance()
Method Detail

getPathLength

public double getPathLength()

getDiameter

public double getDiameter()
Returns:

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 -
attributeModel - The elements attributes, and where to write table results

execute

public void execute(HierarchicalGraph hgraph,
                    AttributeModel attributeModel)

setNormalized

public void setNormalized(boolean isNormalized)

isNormalized

public boolean isNormalized()

setDirected

public void setDirected(boolean isDirected)

isDirected

public boolean isDirected()

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:

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:

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 -

Gephi Toolkit Javadoc