Module org.jgrapht.io

Package org.jgrapht.nio.json

Class JSONEventDrivenImporter

java.lang.Object

org.jgrapht.nio.BaseEventDrivenImporter<java.lang.String,Triple<java.lang.String,java.lang.String,java.lang.Double>>

org.jgrapht.nio.json.JSONEventDrivenImporter

All Implemented Interfaces:

EventDrivenImporter<java.lang.String,Triple<java.lang.String,java.lang.String,java.lang.Double>>

public class JSONEventDrivenImporter
extends BaseEventDrivenImporter<java.lang.String,Triple<java.lang.String,java.lang.String,java.lang.Double>>
implements EventDrivenImporter<java.lang.String,Triple<java.lang.String,java.lang.String,java.lang.Double>>

Imports a graph from a JSON file. Below is a small example of a graph in JSON format.

 {
   "nodes": [
     { "id": "1" },
     { "id": "2", "label": "Node 2 label" },
     { "id": "3" }
   ],
   "edges": [
     { "source": "1", "target": "2", "weight": 2.0, "label": "Edge between 1 and 2" },
     { "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 the default edge weight is returned. The importer also supports reading additional string attributes such as label or custom user attributes.

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

 {
   "nodes": [
     { "id": "1" },
     { "id": "2" }
   ],
   "edges": [
     { "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}. The same is done for arrays or any other arbitrary nested structure.

Author:

Dimitrios Michail

Constructor Summary

Constructors

Constructor	Description
JSONEventDrivenImporter()	Constructs a new importer.
JSONEventDrivenImporter(boolean notifyVertexAttributesOutOfOrder, boolean notifyEdgeAttributesOutOfOrder)	Constructs a new importer.

Method Summary

Modifier and Type	Method	Description
void	importInput(java.io.Reader input)	Import a graph

Methods inherited from class org.jgrapht.nio.BaseEventDrivenImporter

addEdgeAttributeConsumer, addEdgeConsumer, addEdgeCountConsumer, addEdgeWithAttributesConsumer, addGraphAttributeConsumer, addImportEventConsumer, addVertexAttributeConsumer, addVertexConsumer, addVertexCountConsumer, addVertexWithAttributesConsumer, notifyEdge, notifyEdgeAttribute, notifyEdgeCount, notifyEdgeWithAttributes, notifyGraphAttribute, notifyImportEvent, notifyVertex, notifyVertexAttribute, notifyVertexCount, notifyVertexWithAttributes, removeEdgeAttributeConsumer, removeEdgeConsumer, removeEdgeCountConsumer, removeEdgeWithAttributesConsumer, removeGraphAttributeConsumer, removeImportEventConsumer, removeVertexAttributeConsumer, removeVertexConsumer, removeVertexCountConsumer, removeVertexWithAttributesConsumer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jgrapht.nio.EventDrivenImporter

addEdgeAttributeConsumer, addEdgeConsumer, addEdgeCountConsumer, addEdgeWithAttributesConsumer, addGraphAttributeConsumer, addImportEventConsumer, addVertexAttributeConsumer, addVertexConsumer, addVertexCountConsumer, addVertexWithAttributesConsumer, importInput, importInput, removeEdgeAttributeConsumer, removeEdgeConsumer, removeEdgeCountConsumer, removeEdgeWithAttributesConsumer, removeGraphAttributeConsumer, removeImportEventConsumer, removeVertexAttributeConsumer, removeVertexConsumer, removeVertexCountConsumer, removeVertexWithAttributesConsumer

Constructor Detail

JSONEventDrivenImporter

public JSONEventDrivenImporter()

Constructs a new importer.

JSONEventDrivenImporter

public JSONEventDrivenImporter(boolean notifyVertexAttributesOutOfOrder,
                               boolean notifyEdgeAttributesOutOfOrder)

Constructs a new importer.

Parameters:

notifyVertexAttributesOutOfOrder - whether to notify for vertex attributes out-of-order even if they appear together in the input

notifyEdgeAttributesOutOfOrder - whether to notify for edge attributes out-of-order even if they appear together in the input

Method Detail

importInput

public void importInput(java.io.Reader input)

Description copied from interface: EventDrivenImporter

Import a graph

Specified by:

importInput in interface EventDrivenImporter<java.lang.String,Triple<java.lang.String,java.lang.String,java.lang.Double>>

Parameters:

input - the input reader