org.graffiti.plugins.algorithms.springembedder
Class KKSpringAlgorithm

java.lang.Object
  org.graffiti.plugin.AbstractParametrizable
      org.graffiti.plugin.algorithm.AbstractAlgorithm
          org.graffiti.plugins.algorithms.springembedder.KKSpringAlgorithm

All Implemented Interfaces:

Algorithm, Parametrizable

public class KKSpringAlgorithm
extends AbstractAlgorithm

An inefficient spring embedder algorithm loosely based on Kamada & Kawai.

Constructor Summary

KKSpringAlgorithm()
Constructs a new instance.

Method Summary

void	check() Checks whether all preconditions of the current graph are satisfied.
void	execute() Executes the whole algorithm.
Parameter<?>[]	getAlgorithmParameters()
String	getName() Returns the name (id) of this Parametrizable.
void	reset() Resets the internal state of the algorithm.
void	setAlgorithmParameters(Parameter<?>[] params)
void	setBoundingRectangle(Rectangle rect) This is used when the algorithm uses a grid instead of a spring embedder because there are too many nodes.

Methods inherited from class org.graffiti.plugin.algorithm.AbstractAlgorithm

attach, getAnimation, supportsAnimation

Methods inherited from class org.graffiti.plugin.AbstractParametrizable

copyParameters, getDefaultParameters, getParameters, getUserParameters, saveUserParameters, saveUserParameters, setParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graffiti.plugin.Parametrizable

getDefaultParameters, getParameters, setParameters

Constructor Detail

KKSpringAlgorithm

public KKSpringAlgorithm()

Constructs a new instance.

Method Detail

setBoundingRectangle

public void setBoundingRectangle(Rectangle rect)

This is used when the algorithm uses a grid instead of a spring embedder because there are too many nodes.

Parameters:

rect -

getName

public String getName()

Description copied from interface: org.graffiti.plugin.Parametrizable

Returns the name (id) of this Parametrizable.

Returns:

DOCUMENT ME!

See Also:

Parametrizable.getName()

setAlgorithmParameters

public void setAlgorithmParameters(Parameter<?>[] params)

Overrides:

setAlgorithmParameters in class AbstractParametrizable

See Also:

AbstractParametrizable.setAlgorithmParameters(Parameter[])

getAlgorithmParameters

public Parameter<?>[] getAlgorithmParameters()

Overrides:

getAlgorithmParameters in class AbstractParametrizable

See Also:

AbstractParametrizable.getAlgorithmParameters()

check

public void check()
           throws PreconditionException

Description copied from interface: org.graffiti.plugin.algorithm.Algorithm

Checks whether all preconditions of the current graph are satisfied.

Specified by:

check in interface Algorithm

Overrides:

check in class AbstractAlgorithm

Throws:

PreconditionException - if the preconditions of the current graph are not satisfied.

See Also:

Algorithm.check()

execute

public void execute()

Description copied from interface: org.graffiti.plugin.algorithm.Algorithm

Executes the whole algorithm.

See Also:

Algorithm.execute()

reset

public void reset()

Description copied from interface: org.graffiti.plugin.algorithm.Algorithm

Resets the internal state of the algorithm.

Specified by:

reset in interface Algorithm

Overrides:

reset in class AbstractAlgorithm

See Also:

Algorithm.reset()