org.gephi.layout.plugin.openord

Class OpenOrdLayout

java.lang.Object

org.gephi.layout.plugin.openord.OpenOrdLayout

All Implemented Interfaces:

Layout, LongTask

public class OpenOrdLayout
extends Object
implements Layout, LongTask

Author:

Mathieu Bastian

Constructor Summary

Constructors

Constructor and Description
OpenOrdLayout(LayoutBuilder builder)

Method Summary

Modifier and Type	Method and Description
boolean	canAlgo() Tests if the algorithm can run, called before each pass.
boolean	cancel() Cancel the task.
void	endAlgo() Called when the algorithm is finished (canAlgo() returns false).
LayoutBuilder	getBuilder() The reference to the LayoutBuilder that instanciated this Layout.
Control	getControl()
Integer	getCooldownStage()
Integer	getCrunchStage()
Float	getEdgeCut()
Integer	getExpansionStage()
org.gephi.graph.api.Graph	getGraph()
Integer	getLiquidStage()
Integer	getNumIterations()
Integer	getNumThreads()
LayoutProperty[]	getProperties() The properties for this layout.
Long	getRandSeed()
Float	getRealTime()
Integer	getSimmerStage()
Worker[]	getWorkers()
void	goAlgo() Run a step in the algorithm, should be called only if canAlgo() returns true.
void	initAlgo() initAlgo() is called to initialize the algorithm (prepare to run).
void	resetPropertiesValues() Resets the properties values to the default values.
void	setCooldownStage(Integer value)
void	setCrunchStage(Integer value)
void	setEdgeCut(Float edgeCut)
void	setExpansionStage(Integer value)
void	setGraphModel(org.gephi.graph.api.GraphModel graphModel) Injects the graph model for the graph this Layout should operate on.
void	setLiquidStage(Integer value)
void	setNumIterations(Integer numIterations)
void	setNumThreads(Integer numThreads)
void	setProgressTicket(ProgressTicket progressTicket) Set the progress ticket for the long task.
void	setRandSeed(Long randSeed)
void	setRealTime(Float realTime)
void	setRunning(Boolean running)
void	setSimmerStage(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenOrdLayout

public OpenOrdLayout(LayoutBuilder builder)

Method Detail

resetPropertiesValues

public void resetPropertiesValues()

Description copied from interface: Layout

Resets the properties values to the default values.

Specified by:

resetPropertiesValues in interface Layout

initAlgo

public void initAlgo()

Description copied from interface: Layout

initAlgo() is called to initialize the algorithm (prepare to run).

Specified by:

initAlgo in interface Layout

goAlgo

public void goAlgo()

Description copied from interface: Layout

Run a step in the algorithm, should be called only if canAlgo() returns true.

Specified by:

goAlgo in interface Layout

endAlgo

public void endAlgo()

Description copied from interface: Layout

Called when the algorithm is finished (canAlgo() returns false).

Specified by:

endAlgo in interface Layout

canAlgo

public boolean canAlgo()

Description copied from interface: Layout

Tests if the algorithm can run, called before each pass.

Specified by:

canAlgo in interface Layout

Returns:

true if the algorithm can run, false otherwise

setGraphModel

public void setGraphModel(org.gephi.graph.api.GraphModel graphModel)

Description copied from interface: Layout

Injects the graph model for the graph this Layout should operate on.

It's preferable to get visible graph to perform on visualization.

Specified by:

setGraphModel in interface Layout

Parameters:

graphModel - the graph model that the layout is to be working on

getProperties

public LayoutProperty[] getProperties()

Description copied from interface: Layout

The properties for this layout.

Specified by:

getProperties in interface Layout

Returns:

the layout properties

getEdgeCut

public Float getEdgeCut()

setEdgeCut

public void setEdgeCut(Float edgeCut)

getNumThreads

public Integer getNumThreads()

setNumThreads

public void setNumThreads(Integer numThreads)

getRandSeed

public Long getRandSeed()

setRandSeed

public void setRandSeed(Long randSeed)

setRunning

public void setRunning(Boolean running)

getNumIterations

public Integer getNumIterations()

setNumIterations

public void setNumIterations(Integer numIterations)

getRealTime

public Float getRealTime()

setRealTime

public void setRealTime(Float realTime)

getLiquidStage

public Integer getLiquidStage()

getExpansionStage

public Integer getExpansionStage()

getCooldownStage

public Integer getCooldownStage()

getCrunchStage

public Integer getCrunchStage()

getSimmerStage

public Integer getSimmerStage()

setLiquidStage

public void setLiquidStage(Integer value)

setExpansionStage

public void setExpansionStage(Integer value)

setCooldownStage

public void setCooldownStage(Integer value)

setCrunchStage

public void setCrunchStage(Integer value)

setSimmerStage

public void setSimmerStage(Integer value)

getBuilder

public LayoutBuilder getBuilder()

Description copied from interface: Layout

The reference to the LayoutBuilder that instanciated this Layout.

Specified by:

getBuilder in interface Layout

Returns:

the reference to the builder that builts this instance

getWorkers

public Worker[] getWorkers()

getGraph

public org.gephi.graph.api.Graph getGraph()

getControl

public Control getControl()

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