Module org.jgrapht.io
Package org.jgrapht.nio.gml

Class GmlEventDrivenImporter

java.lang.Object
org.jgrapht.nio.BaseEventDrivenImporter<Integer,Triple<Integer,Integer,Double>>
org.jgrapht.nio.gml.GmlEventDrivenImporter
All Implemented Interfaces:
EventDrivenImporter<Integer,Triple<Integer,Integer,Double>>
public class GmlEventDrivenImporter extends BaseEventDrivenImporter<Integer,Triple<Integer,Integer,Double>> implements EventDrivenImporter<Integer,Triple<Integer,Integer,Double>>
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"
   ]
 ]

If the input file contains edge weights then the importer also reads edge weights. 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