Module org.jgrapht.core
Package org.jgrapht.generate

Class StarGraphGenerator<V,​E>

  • Type Parameters:
    V - the graph vertex type
    E - the graph edge type
    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.
    Author:
    Andrew Newell

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CENTER_VERTEX  

    • Constructor Summary

      Constructors 
      Constructor Description
      StarGraphGenerator​(int order)
      Creates a new StarGraphGenerator object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void generateGraph​(Graph<V,​E> target, 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

    • Constructor Detail

      • StarGraphGenerator

        public StarGraphGenerator​(int order)
        Creates a new StarGraphGenerator object.
        Parameters:
        order - number of total vertices including the center vertex
        Throws:
        java.lang.IllegalArgumentException - if the order is negative

    • Method Detail

      • generateGraph

        public void generateGraph​(Graph<V,​E> target,
                          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
        resultMap - if non-null, receives implementation-specific mappings from String roles to graph elements (or collections of graph elements)