org.graffiti.plugins.algorithms.generators
Class CirculantGraphGenerator

java.lang.Object
  extended by org.graffiti.plugin.AbstractParametrizable
      extended by org.graffiti.plugin.algorithm.AbstractAlgorithm
          extended by org.graffiti.plugins.algorithms.generators.AbstractGenerator
              extended by org.graffiti.plugins.algorithms.generators.CirculantGraphGenerator
All Implemented Interfaces:
Algorithm, Parametrizable

public class CirculantGraphGenerator
extends AbstractGenerator

This generator creates a graph with n nodes and connects every node x with the nodes specified as parameters. That means: If the specified nodes are e.g. 2, 4 and 5, this algorithm creates edges from node x to the nodes x + 2, x + 4 and x + 5.


Field Summary
 
Fields inherited from class org.graffiti.plugins.algorithms.generators.AbstractGenerator
DYNAMIC_CIRCLE, RANDOM, STATIC_CIRCLE
 
Constructor Summary
CirculantGraphGenerator()
          Constructs a new instance.
 
Method Summary
 void check()
          Checks whether all preconditions of the current graph are satisfied.
 void execute()
          Executes the whole algorithm.
 String getName()
          Returns the name (id) of this Parametrizable.
 Collection<Integer> getNodesList()
          Returns the nodesList.
 int getNumberOfNodes()
          Returns the numberOfNodes.
 boolean isDirected()
          Returns the directed.
 void reset()
          Resets the internal state of the algorithm.
 void setDirected(boolean directed)
          Sets the directed.
 void setNodesList(Collection<Integer> nodesList)
          Sets the nodesList.
 void setNumberOfNodes(int numberOfNodes)
          Sets the numberOfNodes.
 
Methods inherited from class org.graffiti.plugins.algorithms.generators.AbstractGenerator
getAlgorithmParameters
 
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

CirculantGraphGenerator

public CirculantGraphGenerator()
Constructs a new instance.

Method Detail

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()

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 AbstractGenerator
See Also:
Algorithm.reset()

isDirected

public boolean isDirected()
Returns the directed.

Returns:
the directed.

setDirected

public void setDirected(boolean directed)
Sets the directed.

Parameters:
directed - the directed to set.

getNodesList

public Collection<Integer> getNodesList()
Returns the nodesList.

Returns:
the nodesList.

setNodesList

public void setNodesList(Collection<Integer> nodesList)
Sets the nodesList.

Parameters:
nodesList - the nodesList to set.

getNumberOfNodes

public int getNumberOfNodes()
Returns the numberOfNodes.

Returns:
the numberOfNodes.

setNumberOfNodes

public void setNumberOfNodes(int numberOfNodes)
Sets the numberOfNodes.

Parameters:
numberOfNodes - the numberOfNodes to set.


Generated at 2012-05-30 11:01:25 PM CEST