Module org.jgrapht.io
Package org.jgrapht.nio.dot

Class DOTImporter<V,​E>

  • Type Parameters:
    V - the graph vertex type
    E - the graph edge type
    All Implemented Interfaces:
    GraphImporter<V,​E>
    public class DOTImporter<V,​E>
extends BaseEventDrivenImporter<V,​E>
implements GraphImporter<V,​E>
    Import a graph from a DOT file.

    For a description of the format see http://en.wikipedia.org/wiki/DOT_language and http://www.graphviz.org/doc/info/lang.html

    The provided graph object, where the imported graph will be stored, must be able to support the features of the graph that is read. For example if the file contains self-loops then the graph provided must also support self-loops. The same for multiple edges. Whether edges are directed or not depends on the underlying implementation of the user provided graph object.

    The graph vertices and edges are build using the corresponding graph suppliers. The id of the vertices in the original dot file are reported as a vertex attribute named "ID". Thus, in case vertices in the dot file also contain an "ID" attribute, such an attribute will be reported multiple times.

    The default behavior of the importer is to use the graph vertex supplier in order to create vertices. The user can also bypass vertex creation by providing a custom vertex factory method using setVertexFactory(Function). The factory method is responsible to create a new graph vertex given the vertex identifier read from file. Additionally this importer also supports creating vertices with setVertexWithAttributesFactory(BiFunction). This factory method is responsible for creating a new graph vertex given the vertex identifier read from file together with all available attributes of the vertex at the location of the file where the vertex is first defined.

    The default behavior of the importer is to use the graph edge supplier in order to create edges. The user can also bypass edge creation by providing a custom edge factory method using setEdgeWithAttributesFactory(Function). The factory method is responsible to create a new graph edge given all available attributes of the edge at the location of the file where the edge is first defined.

    Author:
    Dimitrios Michail

    • Field Detail

      • DEFAULT_VERTEX_ID_KEY

        public static final String DEFAULT_VERTEX_ID_KEY
        Default key used for vertex ID.
        See Also:
        Constant Field Values

    • Constructor Detail

      • DOTImporter

        public DOTImporter()
        Constructs a new importer.

    • Method Detail

      • importGraph

        public void importGraph​(Graph<V,​E> graph,
                        Reader input)
        Description copied from interface: GraphImporter
        Import a graph using the given Reader.

        It is the callers responsibility to ensure the Reader is closed after this method returned.

        Specified by:
        importGraph in interface GraphImporter<V,​E>
        Parameters:
        graph - the graph
        input - the input reader

      • getVertexFactory

        public Function<String,​V> getVertexFactory()
        Get the user custom vertex factory. This is null by default and the graph supplier is used instead.
        Returns:
        the user custom vertex factory

      • setVertexFactory

        public void setVertexFactory​(Function<String,​V> vertexFactory)
        Set the user custom vertex factory. The default behavior is being null in which case the graph vertex supplier is used. If supplied the vertex factory is called every time a new vertex is encountered in the input. The method is called with parameter the vertex identifier from the input and should return the actual graph vertex to add to the graph.
        Parameters:
        vertexFactory - a vertex factory

      • getVertexWithAttributesFactory

        public BiFunction<String,​Map<String,​Attribute>,​V> getVertexWithAttributesFactory()
        Get the user custom vertex factory with attributes. This is null by default and the graph supplier is used instead.
        Returns:
        the user custom vertex factory with attributes.

      • setVertexWithAttributesFactory

        public void setVertexWithAttributesFactory​(BiFunction<String,​Map<String,​Attribute>,​V> vertexWithAttributesFactory)
        Set the user custom vertex factory with attributes. The default behavior is being null in which case the graph vertex supplier is used. If supplied the vertex factory is called every time a new vertex is encountered in the input. The method is called with parameter the vertex identifier from the input and a set of attributes and should return the actual graph vertex to add to the graph. Note that the set of attributes might not be complete, as only attributes available at the first vertex definition are collected.
        Parameters:
        vertexWithAttributesFactory - a vertex factory with attributes

      • getEdgeWithAttributesFactory

        public Function<Map<String,​Attribute>,​E> getEdgeWithAttributesFactory()
        Get the user custom edges factory with attributes. This is null by default and the graph supplier is used instead.
        Returns:
        the user custom edge factory with attributes.

      • setEdgeWithAttributesFactory

        public void setEdgeWithAttributesFactory​(Function<Map<String,​Attribute>,​E> edgeWithAttributesFactory)
        Set the user custom edge factory with attributes. The default behavior is being null in which case the graph edge supplier is used. If supplied the edge factory is called every time a new edge is encountered in the input. The method is called with parameter the set of attributes and should return the actual graph edge to add to the graph. Note that the set of attributes might not be complete, as only attributes available at the first edge definition are collected.
        Parameters:
        edgeWithAttributesFactory - an edge factory with attributes