org.gephi.statistics.plugin.dynamic
Class DynamicClusteringCoefficient

java.lang.Object
  org.gephi.statistics.plugin.dynamic.DynamicClusteringCoefficient

All Implemented Interfaces:

DynamicStatistics, Statistics, LongTask

public class DynamicClusteringCoefficient
extends java.lang.Object
implements DynamicStatistics, LongTask

Author:

Mathieu Bastian

Field Summary

static java.lang.String	DYNAMIC_AVG_CLUSTERING_COEFFICIENT
static java.lang.String	DYNAMIC_CLUSTERING_COEFFICIENT

Constructor Summary

DynamicClusteringCoefficient()

Method Summary

boolean	cancel() Cancel the task.
void	end() Called at the end of the process after all loops.
void	execute(GraphModel graphModel, AttributeModel attributeModel) First method to be executed in the dynamic statistic process.
Interval	getBounds() Returns the min and max bounds.
java.lang.String	getReport() Returns an HTML string that displays the statistics result.
double	getTick() Returns the tick.
double	getWindow() Returns the window duration
boolean	isAverageOnly()
boolean	isDirected()
void	loop(GraphView window, Interval interval) Iteration of the dynamic statistics algorithm on a new interval.
void	setAverageOnly(boolean averageOnly)
void	setBounds(Interval bounds) Sets the minimum and maximum bound
void	setDirected(boolean isDirected)
void	setProgressTicket(ProgressTicket progressTicket) Set the progress ticket for the long task.
void	setTick(double tick) Sets the tick.
void	setWindow(double window) Sets the window duration

Methods inherited from class java.lang.Object

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

Field Detail

DYNAMIC_AVG_CLUSTERING_COEFFICIENT

public static final java.lang.String DYNAMIC_AVG_CLUSTERING_COEFFICIENT

See Also:

Constant Field Values

DYNAMIC_CLUSTERING_COEFFICIENT

public static final java.lang.String DYNAMIC_CLUSTERING_COEFFICIENT

See Also:

Constant Field Values

Constructor Detail

DynamicClusteringCoefficient

public DynamicClusteringCoefficient()

Method Detail

execute

public void execute(GraphModel graphModel,
                    AttributeModel attributeModel)

Description copied from interface: DynamicStatistics

First method to be executed in the dynamic statistic process. Initialize the statistics with the graph and attributes. The graph model holds the graph structure and the attribute model the attribute columns.

Specified by:

execute in interface DynamicStatistics

Specified by:

execute in interface Statistics

Parameters:

graphModel - the graph model

attributeModel - the attribute model

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

loop

public void loop(GraphView window,
                 Interval interval)

Description copied from interface: DynamicStatistics

Iteration of the dynamic statistics algorithm on a new interval. The graph window is a snapshot of the graph at the current interval.

Specified by:

loop in interface DynamicStatistics

Parameters:

window - a snapshot of the graph at the current interval

interval - the interval of the current snapshot

end

public void end()

Description copied from interface: DynamicStatistics

Called at the end of the process after all loops.

Specified by:

end in interface DynamicStatistics

setBounds

public void setBounds(Interval bounds)

Description copied from interface: DynamicStatistics

Sets the minimum and maximum bound

Specified by:

setBounds in interface DynamicStatistics

Parameters:

bounds - the min and max bounds

setWindow

public void setWindow(double window)

Description copied from interface: DynamicStatistics

Sets the window duration

Specified by:

setWindow in interface DynamicStatistics

Parameters:

window - the window duration

setTick

public void setTick(double tick)

Description copied from interface: DynamicStatistics

Sets the tick. The tick is how much the window is moved to the right at each iteration.

Specified by:

setTick in interface DynamicStatistics

Parameters:

tick - the tick

getWindow

public double getWindow()

Description copied from interface: DynamicStatistics

Returns the window duration

Specified by:

getWindow in interface DynamicStatistics

Returns:

the window duration

getTick

public double getTick()

Description copied from interface: DynamicStatistics

Returns the tick. The tick is how much the window is moved to the right at each iteration.

Specified by:

getTick in interface DynamicStatistics

Returns:

the tick

getBounds

public Interval getBounds()

Description copied from interface: DynamicStatistics

Returns the min and max bounds.

Specified by:

getBounds in interface DynamicStatistics

Returns:

the bounds

setDirected

public void setDirected(boolean isDirected)

isDirected

public boolean isDirected()

setAverageOnly

public void setAverageOnly(boolean averageOnly)

isAverageOnly

public boolean isAverageOnly()

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