com.orientechnologies.orient.graph.graphml

Class OGraphMLReader

java.lang.Object

com.orientechnologies.orient.graph.graphml.OGraphMLReader

public class OGraphMLReader
extends Object

GraphMLReader writes the data from a GraphML stream to a graph. Derived from Blueprints GraphMLReader. Supports also vertex labels.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com) (l.garulli(at)orientdb.com), Marko A. Rodriguez (http://markorodriguez.com), Alex Averbuch (alex.averbuch-at-gmail.com), Joshua Shinavier (http://fortytwo.net)

Constructor Summary

Constructors

Constructor and Description
OGraphMLReader(OrientBaseGraph graph)

Method Summary

Modifier and Type	Method and Description
OGraphMLReader	defineEdgeAttributeStrategy(String iAttributeName, OGraphMLImportStrategy iStrategy) Define custom strategy to use for edge attribute.
OGraphMLReader	defineVertexAttributeStrategy(String iAttributeName, OGraphMLImportStrategy iStrategy) Define custom strategy to use for vertex attribute.
int	getBatchSize()
OCommandOutputListener	getOutput()
int	getVertexLabelIndex()
void	inputGraph(com.tinkerpop.blueprints.Graph inputGraph, InputStream graphMLInputStream) Input the GraphML stream data into the graph.
OGraphMLReader	inputGraph(com.tinkerpop.blueprints.Graph inputGraph, InputStream graphMLInputStream, int bufferSize, String vertexIdKey, String edgeIdKey, String edgeLabelKey) Input the GraphML stream data into the graph.
void	inputGraph(com.tinkerpop.blueprints.Graph inputGraph, String filename) Input the GraphML stream data into the graph.
OGraphMLReader	inputGraph(com.tinkerpop.blueprints.Graph inputGraph, String filename, int bufferSize, String vertexIdKey, String edgeIdKey, String edgeLabelKey) Input the GraphML stream data into the graph.
OGraphMLReader	inputGraph(InputStream graphMLInputStream) Input the GraphML stream data into the graph.
OGraphMLReader	inputGraph(InputStream graphMLInputStream, int bufferSize) Input the GraphML stream data into the graph.
OGraphMLReader	inputGraph(String filename) Input the GraphML stream data into the graph.
OGraphMLReader	inputGraph(String filename, int bufferSize) Input the GraphML stream data into the graph.
boolean	isStoreVertexIds()
protected void	mapId(Map<String,ORID> vertexMappedIdMap, String vertexId, ORID rid)
protected void	printStatus(XMLStreamReader input, long importedVertices, long importedEdges)
void	setBatchSize(int batchSize)
void	setEdgeIdKey(String edgeIdKey)
void	setEdgeLabelKey(String edgeLabelKey)
OGraphMLReader	setOptions(Map<String,List<String>> opts)
OGraphMLReader	setOutput(OCommandOutputListener output)
void	setStoreVertexIds(boolean storeVertexIds)
void	setVertexIdKey(String vertexIdKey)
void	setVertexLabelIndex(int vertexLabelIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

OGraphMLReader

public OGraphMLReader(OrientBaseGraph graph)

Parameters:

graph - the graph to populate with the GraphML data

Method Detail

defineVertexAttributeStrategy

public OGraphMLReader defineVertexAttributeStrategy(String iAttributeName,
                                                    OGraphMLImportStrategy iStrategy)

Define custom strategy to use for vertex attribute.

Parameters:

iAttributeName - attribute name

iStrategy - strategy implementation

defineEdgeAttributeStrategy

public OGraphMLReader defineEdgeAttributeStrategy(String iAttributeName,
                                                  OGraphMLImportStrategy iStrategy)

Define custom strategy to use for edge attribute.

Parameters:

iAttributeName - attribute name

iStrategy - strategy implementation

inputGraph

public void inputGraph(com.tinkerpop.blueprints.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 void inputGraph(com.tinkerpop.blueprints.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 OGraphMLReader inputGraph(com.tinkerpop.blueprints.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 OGraphMLReader inputGraph(com.tinkerpop.blueprints.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

getVertexLabelIndex

public int getVertexLabelIndex()

setVertexLabelIndex

public void setVertexLabelIndex(int vertexLabelIndex)

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 OGraphMLReader 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 OGraphMLReader 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 OGraphMLReader 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 OGraphMLReader 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

isStoreVertexIds

public boolean isStoreVertexIds()

setStoreVertexIds

public void setStoreVertexIds(boolean storeVertexIds)

setOptions

public OGraphMLReader setOptions(Map<String,List<String>> opts)

getBatchSize

public int getBatchSize()

setBatchSize

public void setBatchSize(int batchSize)

mapId

protected void mapId(Map<String,ORID> vertexMappedIdMap,
                     String vertexId,
                     ORID rid)

getOutput

public OCommandOutputListener getOutput()

setOutput

public OGraphMLReader setOutput(OCommandOutputListener output)

printStatus

protected void printStatus(XMLStreamReader input,
                           long importedVertices,
                           long importedEdges)