Package org.jgrapht.io

Class GmlImporter<V,​E>

  • Type Parameters:
    V - the vertex type
    E - the edge type
    All Implemented Interfaces:
    GraphImporter<V,​E>
    @Deprecated
public class GmlImporter<V,​E>
extends Object
implements GraphImporter<V,​E>
    Deprecated.
    Use GmlImporter instead
    Imports a graph from a GML file (Graph Modeling Language).

    For a description of the format see http://www.infosun.fmi.uni-passau.de/Graphlet/GML/.

    Below is small example of a graph in GML format. 

     graph [
   node [ 
     id 1
   ]
   node [
     id 2
     label "Node 2 has an optional label"
   ]
   node [
     id 3
   ]
   edge [
     source 1
     target 2 
     weight 2.0
     label "Edge between 1 and 2"
   ]
   edge [
     source 2
     target 3
     weight 3.0
     label "Edge between 2 and 3"
   ]
 ]

    In case the graph is weighted then the importer also reads edge weights. Otherwise edge weights are ignored. The importer also supports reading additional string attributes such as label or custom user attributes. String attributes are unescaped as if they are Java strings.

    The parser completely ignores elements from the input that are not related to vertices or edges of the graph. Moreover, complicated nested structures are simply returned as a whole. For example, in the following graph 

     graph [
   node [ 
     id 1
   ]
   node [ 
     id 2
   ]
   edge [
     source 1
     target 2 
     points [ x 1.0 y 2.0 ]
   ]
 ]
    the points attribute of the edge is returned as a string containing "[ x 1.0 y 2.0 ]".
    Author:
    Dimitrios Michail

    • Field Detail

      • vertexProvider

        protected VertexProvider<V> vertexProvider
        Deprecated.
        Constructs new vertices

      • edgeProvider

        protected EdgeProvider<V,​E> edgeProvider
        Deprecated.
        Constructs new edges

      • vertexUpdater

        protected ComponentUpdater<V> vertexUpdater
        Deprecated.
        Updates already constructed vertices

      • graphUpdater

        protected ComponentUpdater<Graph<V,​E>> graphUpdater
        Deprecated.
        Updates graph properties

    • Constructor Detail

      • GmlImporter

        public GmlImporter​(VertexProvider<V> vertexProvider,
                   EdgeProvider<V,​E> edgeProvider)
        Deprecated.
        Constructs a new importer.
        Parameters:
        vertexProvider - provider for the generation of vertices. Must not be null.
        edgeProvider - provider for the generation of edges. Must not be null.

    • Method Detail

      • importGraph

        public void importGraph​(Graph<V,​E> graph,
                        Reader input)
                 throws ImportException
        Deprecated.
        Import a graph.

        The provided graph must be able to support the features of the graph that is read. For example if the gml file contains self-loops then the graph provided must also support self-loops. The same for multiple edges.

        If the provided graph is a weighted graph, the importer also reads edge weights. Otherwise edge weights are ignored.

        Specified by:
        importGraph in interface GraphImporter<V,​E>
        Parameters:
        graph - the output graph
        input - the input reader
        Throws:
        ImportException - in case an error occurs, such as I/O or parse error

      • getVertexProvider

        public VertexProvider<V> getVertexProvider()
        Deprecated.
        Get the vertex provider
        Returns:
        the vertex provider

      • setVertexProvider

        public void setVertexProvider​(VertexProvider<V> vertexProvider)
        Deprecated.
        Set the vertex provider
        Parameters:
        vertexProvider - the new vertex provider. Must not be null.

      • getEdgeProvider

        public EdgeProvider<V,​E> getEdgeProvider()
        Deprecated.
        Get the edge provider
        Returns:
        The edge provider

      • setEdgeProvider

        public void setEdgeProvider​(EdgeProvider<V,​E> edgeProvider)
        Deprecated.
        Set the edge provider.
        Parameters:
        edgeProvider - the new edge provider. Must not be null.

      • getVertexUpdater

        public ComponentUpdater<V> getVertexUpdater()
        Deprecated.
        Get the vertex updater
        Returns:
        the vertex updater

      • setVertexUpdater

        public void setVertexUpdater​(ComponentUpdater<V> vertexUpdater)
        Deprecated.
        Set the vertex updater.
        Parameters:
        vertexUpdater - the new vertex updater. Must not be null.

      • getGraphUpdater

        public ComponentUpdater<Graph<V,​E>> getGraphUpdater()
        Deprecated.
        Get the graph updater.
        Returns:
        the graph updater

      • setGraphUpdater

        public void setGraphUpdater​(ComponentUpdater<Graph<V,​E>> graphUpdater)
        Deprecated.
        Set the graph updater.
        Parameters:
        graphUpdater - the new graph updater. Must not be null.