org.jgrapht.generate
Class StarGraphGenerator<V,E>

java.lang.Object
  extended by org.jgrapht.generate.StarGraphGenerator<V,E>
All Implemented Interfaces:
GraphGenerator<V,E,V>

public class StarGraphGenerator<V,E>
extends java.lang.Object
implements GraphGenerator<V,E,V>

Generates a star graph of any size. This is a graph where every vertex has exactly one edge with a center vertex.

Since:
Dec 21, 2008
Author:
Andrew Newell

Field Summary
static java.lang.String CENTER_VERTEX
           
 
Constructor Summary
StarGraphGenerator(int order)
          Creates a new StarGraphGenerator object.
 
Method Summary
 void generateGraph(Graph<V,E> target, VertexFactory<V> vertexFactory, java.util.Map<java.lang.String,V> resultMap)
          Generates a star graph with the designated order from the constructor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CENTER_VERTEX

public static final java.lang.String CENTER_VERTEX
See Also:
Constant Field Values
Constructor Detail

StarGraphGenerator

public StarGraphGenerator(int order)
Creates a new StarGraphGenerator object.

Parameters:
order - number of total vertices including the center vertex
Method Detail

generateGraph

public void generateGraph(Graph<V,E> target,
                          VertexFactory<V> vertexFactory,
                          java.util.Map<java.lang.String,V> resultMap)
Generates a star graph with the designated order from the constructor

Specified by:
generateGraph in interface GraphGenerator<V,E,V>
Parameters:
target - receives the generated edges and vertices; if this is non-empty on entry, the result will be a disconnected graph since generated elements will not be connected to existing elements
vertexFactory - called to produce new vertices
resultMap - if non-null, receives implementation-specific mappings from String roles to graph elements (or collections of graph elements)