com.tinkerpop.blueprints.util.io.gml

Class GMLReader

java.lang.Object

com.tinkerpop.blueprints.util.io.gml.GMLReader

public class GMLReader
extends Object

A reader for the Graph Modelling Language (GML). GML definition taken from (http://www.fim.uni-passau.de/fileadmin/files/lehrstuhl/brandenburg/projekte/gml/gml-documentation.tar.gz) It's not clear that all node have to have id's or that they have to be integers - we assume that this is the case. We also assume that only one graph can be defined in a file.

Author:

Stuart Hendren (http://stuarthendren.net), Stephen Mallette

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
GMLReader(Graph graph) Create a new GML reader (Uses default edge label DEFAULT_LABEL)
GMLReader(Graph graph, String defaultEdgeLabel) Create a new GML reader

Method Summary

Methods

Modifier and Type	Method and Description
static void	inputGraph(Graph graph, InputStream inputStream) Load the GML file into the Graph.
static void	inputGraph(Graph inputGraph, InputStream inputStream, int bufferSize, String defaultEdgeLabel, String vertexIdKey, String edgeIdKey, String edgeLabelKey) Load the GML file into the Graph.
static void	inputGraph(Graph graph, String filename) Load the GML file into the Graph.
static void	inputGraph(Graph inputGraph, String filename, int bufferSize, String defaultEdgeLabel, String vertexIdKey, String edgeIdKey, String edgeLabelKey) Load the GML file into the Graph.
void	inputGraph(InputStream inputStream) Read the GML from from the stream.
void	inputGraph(InputStream inputStream, int bufferSize) Read the GML from from the stream.
void	inputGraph(String filename) Read the GML from from the stream.
void	inputGraph(String filename, int bufferSize) Read the GML from from the stream.
void	setEdgeIdKey(String edgeIdKey)
void	setEdgeLabelKey(String edgeLabelKey)
void	setVertexIdKey(String vertexIdKey)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LABEL

public static final String DEFAULT_LABEL

See Also:

Constant Field Values

Constructor Detail

GMLReader

public GMLReader(Graph graph)

Create a new GML reader (Uses default edge label DEFAULT_LABEL)

Parameters:

graph - the graph to load data into

GMLReader

public GMLReader(Graph graph,
         String defaultEdgeLabel)

Create a new GML reader

Parameters:

graph - the graph to load data into

defaultEdgeLabel - the default edge label to be used if the GML edge does not define a label

Method Detail

setVertexIdKey

public void setVertexIdKey(String vertexIdKey)

Parameters:

vertexIdKey - gml property to use as id for verticies

setEdgeIdKey

public void setEdgeIdKey(String edgeIdKey)

Parameters:

edgeIdKey - gml property to use as id for edges

setEdgeLabelKey

public void setEdgeLabelKey(String edgeLabelKey)

Parameters:

edgeLabelKey - gml property to assign edge Labels to

inputGraph

public void inputGraph(InputStream inputStream)
                throws IOException

Read the GML from from the stream. If the file is malformed incomplete data can be loaded.

Parameters:

inputStream -

Throws:

IOException

inputGraph

public void inputGraph(String filename)
                throws IOException

Read the GML from from the stream. If the file is malformed incomplete data can be loaded.

Parameters:

filename -

Throws:

IOException

inputGraph

public void inputGraph(InputStream inputStream,
              int bufferSize)
                throws IOException

Read the GML from from the stream. If the file is malformed incomplete data can be loaded.

Parameters:

inputStream -

bufferSize -

Throws:

IOException

inputGraph

public void inputGraph(String filename,
              int bufferSize)
                throws IOException

Read the GML from from the stream. If the file is malformed incomplete data can be loaded.

Parameters:

filename -

bufferSize -

Throws:

IOException

inputGraph

public static void inputGraph(Graph graph,
              String filename)
                       throws IOException

Load the GML file into the Graph.

Parameters:

graph - to receive the data

filename - GML file

Throws:

IOException - thrown if the data is not valid

inputGraph

public static void inputGraph(Graph graph,
              InputStream inputStream)
                       throws IOException

Load the GML file into the Graph.

Parameters:

graph - to receive the data

inputStream - GML file

Throws:

IOException - thrown if the data is not valid

inputGraph

public static void inputGraph(Graph inputGraph,
              String filename,
              int bufferSize,
              String defaultEdgeLabel,
              String vertexIdKey,
              String edgeIdKey,
              String edgeLabelKey)
                       throws IOException

Load the GML file into the Graph.

Parameters:

inputGraph - to receive the data

filename - GML file

defaultEdgeLabel - default edge label to be used if not defined in the data

vertexIdKey - if the id of a vertex is a <data/> property, fetch it from the data property.

edgeIdKey - if the id of an edge is a <data/> property, fetch it from the data property.

edgeLabelKey - if the label of an edge is a <data/> property, fetch it from the data property.

Throws:

IOException - thrown if the data is not valid

inputGraph

public static void inputGraph(Graph inputGraph,
              InputStream inputStream,
              int bufferSize,
              String defaultEdgeLabel,
              String vertexIdKey,
              String edgeIdKey,
              String edgeLabelKey)
                       throws IOException

Load the GML file into the Graph.

Parameters:

inputGraph - to receive the data

inputStream - GML file

defaultEdgeLabel - default edge label to be used if not defined in the data

vertexIdKey - if the id of a vertex is a <data/> property, fetch it from the data property.

edgeIdKey - if the id of an edge is a <data/> property, fetch it from the data property.

edgeLabelKey - if the label of an edge is a <data/> property, fetch it from the data property.

Throws:

IOException - thrown if the data is not valid