com.tinkerpop.blueprints.util.io.graphml

Class GraphMLReader

java.lang.Object

com.tinkerpop.blueprints.util.io.graphml.GraphMLReader

public class GraphMLReader
extends Object

GraphMLReader writes the data from a GraphML stream to a graph.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Alex Averbuch (alex.averbuch@gmail.com), Joshua Shinavier (http://fortytwo.net)

Constructor Summary

Constructors

Constructor and Description
GraphMLReader(Graph graph)

Method Summary

Methods

Modifier and Type	Method and Description
static void	inputGraph(Graph inputGraph, InputStream graphMLInputStream) Input the GraphML stream data into the graph.
static void	inputGraph(Graph inputGraph, InputStream graphMLInputStream, int bufferSize, String vertexIdKey, String edgeIdKey, String edgeLabelKey) Input the GraphML stream data into the graph.
static void	inputGraph(Graph inputGraph, String filename) Input the GraphML stream data into the graph.
static void	inputGraph(Graph inputGraph, String filename, int bufferSize, String vertexIdKey, String edgeIdKey, String edgeLabelKey) Input the GraphML stream data into the graph.
void	inputGraph(InputStream graphMLInputStream) Input the GraphML stream data into the graph.
void	inputGraph(InputStream graphMLInputStream, int bufferSize) Input the GraphML stream data into the graph.
void	inputGraph(String filename) Input the GraphML stream data into the graph.
void	inputGraph(String filename, int bufferSize) Input the GraphML stream data into the graph.
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

Constructor Detail

GraphMLReader

public GraphMLReader(Graph graph)

Parameters:

graph - the graph to populate with the GraphML data

Method Detail

setVertexIdKey

public void setVertexIdKey(String vertexIdKey)

Parameters:

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

setEdgeIdKey

public void setEdgeIdKey(String edgeIdKey)

Parameters:

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

setEdgeLabelKey

public void setEdgeLabelKey(String edgeLabelKey)

Parameters:

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

inputGraph

public void inputGraph(InputStream graphMLInputStream)
                throws IOException

Input the GraphML stream data into the graph. In practice, usually the provided graph is empty.

Parameters:

graphMLInputStream - an InputStream of GraphML data

Throws:

IOException - thrown when the GraphML data is not correctly formatted

inputGraph

public void inputGraph(String filename)
                throws IOException

Input the GraphML stream data into the graph. In practice, usually the provided graph is empty.

Parameters:

filename - name of a file containing GraphML data

Throws:

IOException - thrown when the GraphML data is not correctly formatted

inputGraph

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

Input the GraphML stream data into the graph. In practice, usually the provided graph is empty.

Parameters:

graphMLInputStream - an InputStream of GraphML data

bufferSize - the amount of elements to hold in memory before committing a transactions (only valid for TransactionalGraphs)

Throws:

IOException - thrown when the GraphML data is not correctly formatted

inputGraph

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

Input the GraphML stream data into the graph. In practice, usually the provided graph is empty.

Parameters:

filename - name of a file containing GraphML data

bufferSize - the amount of elements to hold in memory before committing a transactions (only valid for TransactionalGraphs)

Throws:

IOException - thrown when the GraphML data is not correctly formatted

inputGraph

public static void inputGraph(Graph inputGraph,
              InputStream graphMLInputStream)
                       throws IOException

Input the GraphML stream data into the graph. In practice, usually the provided graph is empty.

Parameters:

inputGraph - the graph to populate with the GraphML data

graphMLInputStream - an InputStream of GraphML data

Throws:

IOException - thrown when the GraphML data is not correctly formatted

inputGraph

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

Input the GraphML stream data into the graph. In practice, usually the provided graph is empty.

Parameters:

inputGraph - the graph to populate with the GraphML data

filename - name of a file containing GraphML data

Throws:

IOException - thrown when the GraphML data is not correctly formatted

inputGraph

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

Input the GraphML stream data into the graph. More control over how data is streamed is provided by this method.

Parameters:

inputGraph - the graph to populate with the GraphML data

filename - name of a file containing GraphML data

bufferSize - the amount of elements to hold in memory before committing a transactions (only valid for TransactionalGraphs)

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 when the GraphML data is not correctly formatted

inputGraph

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

Input the GraphML stream data into the graph. More control over how data is streamed is provided by this method.

Parameters:

inputGraph - the graph to populate with the GraphML data

graphMLInputStream - an InputStream of GraphML data

bufferSize - the amount of elements to hold in memory before committing a transactions (only valid for TransactionalGraphs)

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 when the GraphML data is not correctly formatted