java.lang.Object
org.jgrapht.generate.LinearGraphGenerator<V,E>
- Type Parameters:
V
- the graph vertex typeE
- the graph edge type
- All Implemented Interfaces:
GraphGenerator<V,E,V>
public class LinearGraphGenerator<V,E> extends java.lang.Object implements GraphGenerator<V,E,V>
Generates a linear graph of any size. For a directed graph, the edges are oriented from
START_VERTEX to END_VERTEX.
- Author:
- John V. Sichi
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
END_VERTEX
Role for the last vertex generated.static java.lang.String
START_VERTEX
Role for the first vertex generated. -
Constructor Summary
Constructors Constructor Description LinearGraphGenerator(int size)
Construct a new LinearGraphGenerator. -
Method Summary
Modifier and Type Method Description void
generateGraph(Graph<V,E> target, java.util.Map<java.lang.String,V> resultMap)
Generate a graph structure.
-
Field Details
-
START_VERTEX
public static final java.lang.String START_VERTEXRole for the first vertex generated.- See Also:
- Constant Field Values
-
END_VERTEX
public static final java.lang.String END_VERTEXRole for the last vertex generated.- See Also:
- Constant Field Values
-
-
Constructor Details
-
LinearGraphGenerator
public LinearGraphGenerator(int size)Construct a new LinearGraphGenerator.- Parameters:
size
- number of vertices to be generated- Throws:
java.lang.IllegalArgumentException
- if the specified size is negative.
-
-
Method Details
-
generateGraph
Generate a graph structure. The topology of the generated graph is dependent on the implementation. For graphs in which not all vertices share the same automorphism equivalence class, the generator may produce a labeling indicating the roles played by generated elements. This is the purpose of the resultMap parameter. For example, a generator for a wheel graph would designate a hub vertex. Role names used as keys in resultMap should be declared as public static final Strings by implementation classes.- Specified by:
generateGraph
in interfaceGraphGenerator<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 elementsresultMap
- if non-null, receives implementation-specific mappings from String roles to graph elements (or collections of graph elements)
-