org.gephi.statistics.spi

Interface DynamicStatistics

All Superinterfaces:

Statistics

All Known Implementing Classes:

DynamicClusteringCoefficient, DynamicDegree, DynamicNbEdges, DynamicNbNodes

public interface DynamicStatistics
extends Statistics

Define a dynamic statistics implementation. A Dynamic Statistics uses a sliding window on a dynamic network to compute results.

The dynamic statistic execution is a three-steps process:

1. The execute() method is called to init the statistic with the graph and attribute model.
2. For every interval the loop() method is called with the network at this interval as parameter.
3. The end() method is finally called.

Author:

Mathieu Bastian

Method Summary

Modifier and Type	Method and Description
void	end() Called at the end of the process after all loops.
void	execute(org.gephi.graph.api.GraphModel graphModel) First method to be executed in the dynamic statistic process.
org.gephi.graph.api.Interval	getBounds() Returns the min and max bounds.
double	getTick() Returns the tick.
double	getWindow() Returns the window duration
void	loop(org.gephi.graph.api.GraphView window, org.gephi.graph.api.Interval interval) Iteration of the dynamic statistics algorithm on a new interval.
void	setBounds(org.gephi.graph.api.Interval bounds) Sets the minimum and maximum bound
void	setTick(double tick) Sets the tick.
void	setWindow(double window) Sets the window duration

Methods inherited from interface org.gephi.statistics.spi.Statistics

getReport

Method Detail

execute

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

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 Statistics

Parameters:

graphModel - the graph model

loop

void loop(org.gephi.graph.api.GraphView window,
          org.gephi.graph.api.Interval interval)

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

Parameters:

window - a snapshot of the graph at the current interval

interval - the interval of the current snapshot

end

void end()

Called at the end of the process after all loops.

setBounds

void setBounds(org.gephi.graph.api.Interval bounds)

Sets the minimum and maximum bound

Parameters:

bounds - the min and max bounds

setWindow

void setWindow(double window)

Sets the window duration

Parameters:

window - the window duration

setTick

void setTick(double tick)

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

Parameters:

tick - the tick

getWindow

double getWindow()

Returns the window duration

Returns:

the window duration

getTick

double getTick()

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

Returns:

the tick

getBounds

org.gephi.graph.api.Interval getBounds()

Returns the min and max bounds.

Returns:

the bounds