Package org.apache.tinkerpop.gremlin.structure.io.graphml

Class GraphMLIo

java.lang.Object

org.apache.tinkerpop.gremlin.structure.io.graphml.GraphMLIo

All Implemented Interfaces:

Io<GraphMLReader.Builder,GraphMLWriter.Builder,GraphMLMapper.Builder>

public final class GraphMLIo
extends Object
implements Io<GraphMLReader.Builder,GraphMLWriter.Builder,GraphMLMapper.Builder>

Constructs GraphML IO implementations given a Graph and IoRegistry. Implementers of the Graph interfaces do not have to register any special serializers to the IoRegistry as GraphML does not support such things.

Author:

Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GraphMLIo.Builder

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.io.Io

Io.Exceptions

Method Summary

Modifier and Type	Method	Description
static Io.Builder<GraphMLIo>	build()
GraphMLMapper.Builder	mapper()	Constructs a Mapper.Builder which is responsible for constructing the abstraction over different serialization methods.
GraphMLReader.Builder	reader()	Creates a GraphReader.ReaderBuilder implementation .
void	readGraph(String file)	Read a Graph from file using the default configuration of the Io.reader() and its supplied Io.mapper().
void	writeGraph(String file)	Write a Graph to file using the default configuration of the Io.writer() and its supplied Io.mapper().
GraphMLWriter.Builder	writer()	Creates a GraphWriter.WriterBuilder implementation .

Methods inherited from class java.lang.Object

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

Method Details

reader

public GraphMLReader.Builder reader()

Creates a GraphReader.ReaderBuilder implementation . Implementers should call the Io.mapper() function to feed its result to the builder. In this way, custom class serializers registered to the Mapper.Builder by Graph implementations will end up being used for the serialization process.

Specified by:

reader in interface Io<GraphMLReader.Builder,GraphMLWriter.Builder,GraphMLMapper.Builder>

writer

public GraphMLWriter.Builder writer()

Creates a GraphWriter.WriterBuilder implementation . Implementers should call the Io.mapper() function to feed its result to the builder. In this way, custom class serializers registered to the Mapper.Builder by Graph implementations will end up being used for the serialization process.

Specified by:

writer in interface Io<GraphMLReader.Builder,GraphMLWriter.Builder,GraphMLMapper.Builder>

mapper

public GraphMLMapper.Builder mapper()

Constructs a Mapper.Builder which is responsible for constructing the abstraction over different serialization methods. Implementations should set defaults as required, but most importantly need to make the appropriate call to Mapper.Builder.addRegistry(IoRegistry) which will provide the builder with any required custom serializers of the Graph.

Specified by:

mapper in interface Io<GraphMLReader.Builder,GraphMLWriter.Builder,GraphMLMapper.Builder>

writeGraph

public void writeGraph(String file)
                throws IOException

Write a Graph to file using the default configuration of the Io.writer() and its supplied Io.mapper().

Specified by:

writeGraph in interface Io<GraphMLReader.Builder,GraphMLWriter.Builder,GraphMLMapper.Builder>

Throws:

IOException

readGraph

public void readGraph(String file)
               throws IOException

Read a Graph from file using the default configuration of the Io.reader() and its supplied Io.mapper().

Specified by:

readGraph in interface Io<GraphMLReader.Builder,GraphMLWriter.Builder,GraphMLMapper.Builder>

Throws:

IOException

build

public static Io.Builder<GraphMLIo> build()