Gephi Toolkit Javadoc

org.gephi.dynamic.api
Interface DynamicController


public interface DynamicController

This controller maintains the dynamic models, one per Workspace.

It is a service and can therefore be found in Lookup:

 DynamicController dc = Lookup.getDefault().lookup(DynamicController.class);
 

Author:
Cezary Bartosiak, Mathieu Bastian

Method Summary
 void addModelListener(DynamicModelListener listener)
          Adds listener to the listeners of this model.
 DynamicModel getModel()
          Returns the dynamic model for the current workspace, or null if the project is empty.
 DynamicModel getModel(Workspace workspace)
          Returns the dynamic model for the given workspace.
 void removeModelListener(DynamicModelListener listener)
          Removes listener to the listeners of this model.
 void setEstimator(Estimator estimator)
          Sets the current ESTIMATOR used to get values from DynamicType.
 void setEstimator(Estimator estimator, Workspace workspace)
          Sets the current ESTIMATOR used to get values from DynamicType.
 void setNumberEstimator(Estimator estimator)
          Sets the current number ESTIMATOR used to get values from DynamicType.
 void setNumberEstimator(Estimator estimator, Workspace workspace)
          Sets the current number ESTIMATOR used to get values from DynamicType.
 void setTimeFormat(DynamicModel.TimeFormat timeFormat)
          Sets the current time format.
 void setTimeFormat(DynamicModel.TimeFormat timeFormat, Workspace workspace)
          Sets the current time format.
 void setVisibleInterval(double low, double high)
          Sets the time interval wrapped by the DynamicGraph of the current workspace.
 void setVisibleInterval(TimeInterval interval)
          Sets the time interval wrapped by the DynamicGraph of the current workspace.
 

Method Detail

getModel

DynamicModel getModel()
Returns the dynamic model for the current workspace, or null if the project is empty.

Returns:
the current dynamic model.

getModel

DynamicModel getModel(Workspace workspace)
Returns the dynamic model for the given workspace.

Parameters:
workspace - the workspace that dynamic model is to be returned
Returns:
the workspace's dynamic model.

setVisibleInterval

void setVisibleInterval(TimeInterval interval)
Sets the time interval wrapped by the DynamicGraph of the current workspace.

Parameters:
interval - an object to get endpoints from

setVisibleInterval

void setVisibleInterval(double low,
                        double high)
Sets the time interval wrapped by the DynamicGraph of the current workspace.

Parameters:
low - the left endpoint
high - the right endpoint

setTimeFormat

void setTimeFormat(DynamicModel.TimeFormat timeFormat)
Sets the current time format. This should be done when the model is inited.

Parameters:
timeFormat - the time format that is to be set as current

setTimeFormat

void setTimeFormat(DynamicModel.TimeFormat timeFormat,
                   Workspace workspace)
Sets the current time format. This is done on the model provided by the workspace.

Parameters:
timeFormat - the time format that is to be set as current
workspace - the workspace to get the model

setEstimator

void setEstimator(Estimator estimator)
Sets the current ESTIMATOR used to get values from DynamicType. Default is Estimator.FIRST.

Parameters:
estimator - the estimator that is to be set

setEstimator

void setEstimator(Estimator estimator,
                  Workspace workspace)
Sets the current ESTIMATOR used to get values from DynamicType. Default is Estimator.FIRST.

Parameters:
estimator - the estimator that is to be set
workspace - the workspace to get the model

setNumberEstimator

void setNumberEstimator(Estimator estimator)
Sets the current number ESTIMATOR used to get values from DynamicType. Default is Estimator.AVERAGE.

Parameters:
estimator - the number estimator that is to be set

setNumberEstimator

void setNumberEstimator(Estimator estimator,
                        Workspace workspace)
Sets the current number ESTIMATOR used to get values from DynamicType. Default is Estimator.AVERAGE.

Parameters:
estimator - the number estimator that is to be set
workspace - the workspace to get the model

addModelListener

void addModelListener(DynamicModelListener listener)
Adds listener to the listeners of this model. It receives events when model is changed.

Parameters:
listener - the listener that is to be added

removeModelListener

void removeModelListener(DynamicModelListener listener)
Removes listener to the listeners of this model.

Parameters:
listener - the listener that is to be removed

Gephi Toolkit Javadoc