io.jbotsim.io.format.graph6

Class Graph6TopologySerializer

java.lang.Object

io.jbotsim.io.format.graph6.Graph6TopologySerializer

All Implemented Interfaces:

TopologySerializer

public class Graph6TopologySerializer
extends Object
implements TopologySerializer

This class implements support for Graph6 file format as described in https://users.cecs.anu.edu.au/~bdm/data/formats.txt.

Only Graph6 and Digraph6 format are supported. Sparse6 format is not yet implemented.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	GRAPH6_FILENAME_EXTENSIONS Supported filename extensions.

Constructor Summary

Constructors

Constructor and Description
Graph6TopologySerializer()

Method Summary

Modifier and Type	Method and Description
String	exportToString(Topology topology) Encode the graph of topology in Graph6 or Digraph6 file format according to Topology.isDirected().
boolean	generatesHeaders()
void	importFromString(Topology topology, String data) Populate topology with the graph described in data.
void	setGenerateHeaders(boolean generateHeaders)

Methods inherited from class java.lang.Object

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

Field Detail

GRAPH6_FILENAME_EXTENSIONS

public static final String[] GRAPH6_FILENAME_EXTENSIONS

Supported filename extensions. Can be used to populate a TopologySerializerFilenameMatcher.

See Also:

TopologySerializerFilenameMatcher.addTopologySerializer(String, TopologySerializer)

Constructor Detail

Graph6TopologySerializer

public Graph6TopologySerializer()

Method Detail

exportToString

public String exportToString(Topology topology)

Encode the graph of topology in Graph6 or Digraph6 file format according to Topology.isDirected().

Specified by:

exportToString in interface TopologySerializer

Parameters:

topology - The Topology object which must be exported

Returns:

the Graph6 encoding of this topology

importFromString

public void importFromString(Topology topology,
                             String data)

Populate topology with the graph described in data. The orientation of topology might be adjusted wrt to the orientation of the graph in data.

Specified by:

importFromString in interface TopologySerializer

Parameters:

topology - The Topology object which must be populated

data - The String representation.

generatesHeaders

public boolean generatesHeaders()

Returns:

if this serializer produces Graph6 header in outputs

setGenerateHeaders

public void setGenerateHeaders(boolean generateHeaders)

Parameters:

generateHeaders - is true if this serializer has to generate Graph6 headers.