org.jgrapht.generate.GraphGenerator Maven / Gradle / Ivy
/* ==========================================
* JGraphT : a free Java graph-theory library
* ==========================================
*
* Project Info: http://jgrapht.sourceforge.net/
* Project Creator: Barak Naveh (http://sourceforge.net/users/barak_naveh)
*
* (C) Copyright 2003-2008, by Barak Naveh and Contributors.
*
* This program and the accompanying materials are dual-licensed under
* either
*
* (a) the terms of the GNU Lesser General Public License version 2.1
* as published by the Free Software Foundation, or (at your option) any
* later version.
*
* or (per the licensee's choosing)
*
* (b) the terms of the Eclipse Public License v1.0 as published by
* the Eclipse Foundation.
*/
/* -------------------
* GraphGenerator.java
* -------------------
* (C) Copyright 2003-2008, by John V. Sichi and Contributors.
*
* Original Author: John V. Sichi
* Contributor(s): -
*
* $Id$
*
* Changes
* -------
* 16-Sep-2003 : Initial revision (JVS);
*
*/
package org.jgrapht.generate;
import java.util.*;
import org.jgrapht.*;
/**
* GraphGenerator defines an interface for generating new graph structures.
*
* @author John V. Sichi
* @since Sep 16, 2003
*/
public interface GraphGenerator
{
/**
* 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.
*
* @param 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
* @param vertexFactory called to produce new vertices
* @param resultMap if non-null, receives implementation-specific mappings
* from String roles to graph elements (or collections of graph elements)
*/
public void generateGraph(
Graph target,
VertexFactory vertexFactory,
Map resultMap);
}
// End GraphGenerator.java