Package it.univr.di.cstnu.graph

Class TNGraphMLWriter

java.lang.Object

edu.uci.ics.jung.io.GraphMLWriter<LabeledNode,Edge>

it.univr.di.cstnu.graph.TNGraphMLWriter

public class TNGraphMLWriter
extends edu.uci.ics.jung.io.GraphMLWriter<LabeledNode,Edge>

Allows the writing of a Temporal Network graph to a file or a string in GraphML format.
GraphML format allows the definition of different attributes for the TNGraph, vertices and edges.
All attributes are defined in the first part of a GraphML file. Examples of GraphML file that can read by this class are given in the Instances directory under CstnuTool one.
It assumes that nodes are LabeledNode and edges are Edge.

Version:

$Rev: 875 $

Author:

posenato

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EDGE_CASE_VALUE_KEY
static final String	EDGE_LABELED_LC_VALUE_KEY
static final String	EDGE_LABELED_UC_VALUE_KEY
static final String	EDGE_LABELED_VALUE_KEY
static final String	EDGE_TYPE_KEY
static final String	EDGE_VALUE_KEY
static final String	GRAPH_NAME_KEY
static final String	GRAPH_nCTG_KEY
static final String	GRAPH_nEDGES_KEY
static final String	GRAPH_nOBS_KEY
static final String	GRAPH_nVERTICES_KEY
(package private) edu.uci.ics.jung.algorithms.layout.AbstractLayout<LabeledNode,? extends Edge>	layout
(package private) static final Logger	LOG	logger
static final String	NETWORK_TYPE_KEY
(package private) TNGraph.NetworkType	networkType	Graph type
static final String	NODE_LABEL_KEY
static final String	NODE_OBSERVED_KEY
static final String	NODE_PARAMETER_KEY
static final String	NODE_POTENTIAL_KEY
static final String	NODE_X_KEY
static final String	NODE_Y_KEY

Fields inherited from class edu.uci.ics.jung.io.GraphMLWriter

directed, edge_data, edge_desc, edge_ids, graph_data, graph_desc, nest_level, vertex_data, vertex_desc, vertex_ids

Constructor Summary

Constructors

Constructor	Description
TNGraphMLWriter(edu.uci.ics.jung.algorithms.layout.AbstractLayout<LabeledNode,? extends Edge> lay)	Constructor for TNGraphMLWriter.

Method Summary

Modifier and Type	Method	Description
String	save(TNGraph<? extends Edge> graph)	Helper method for making GraphMLWriter.save(Hypergraph, Writer) easier.
void	save(TNGraph<? extends Edge> graph, File outputFile)	Helper method for making GraphMLWriter.save(Hypergraph, Writer) easier.
void	save(TNGraph<? extends Edge> graph, Writer writer)

Methods inherited from class edu.uci.ics.jung.io.GraphMLWriter

addEdgeData, addGraphData, addVertexData, format, save, setEdgeData, setEdgeDescriptions, setEdgeIDs, setGraphData, setGraphDescriptions, setVertexData, setVertexDescriptions, setVertexIDs, writeEdgeData, writeIndentedText, writeKeySpecification, writeVertexData

Methods inherited from class java.lang.Object

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

Field Details

EDGE_CASE_VALUE_KEY

public static final String EDGE_CASE_VALUE_KEY

See Also:

• Constant Field Values

EDGE_LABELED_LC_VALUE_KEY

public static final String EDGE_LABELED_LC_VALUE_KEY

See Also:

• Constant Field Values

EDGE_LABELED_UC_VALUE_KEY

public static final String EDGE_LABELED_UC_VALUE_KEY

See Also:

• Constant Field Values

EDGE_LABELED_VALUE_KEY

public static final String EDGE_LABELED_VALUE_KEY

See Also:

• Constant Field Values

EDGE_TYPE_KEY

public static final String EDGE_TYPE_KEY

See Also:

• Constant Field Values

EDGE_VALUE_KEY

public static final String EDGE_VALUE_KEY

See Also:

• Constant Field Values

GRAPH_NAME_KEY

public static final String GRAPH_NAME_KEY

See Also:

• Constant Field Values

GRAPH_nCTG_KEY

public static final String GRAPH_nCTG_KEY

See Also:

• Constant Field Values

GRAPH_nEDGES_KEY

public static final String GRAPH_nEDGES_KEY

See Also:

• Constant Field Values

GRAPH_nOBS_KEY

public static final String GRAPH_nOBS_KEY

See Also:

• Constant Field Values

GRAPH_nVERTICES_KEY

public static final String GRAPH_nVERTICES_KEY

See Also:

• Constant Field Values

NETWORK_TYPE_KEY

public static final String NETWORK_TYPE_KEY

See Also:

• Constant Field Values

NODE_LABEL_KEY

public static final String NODE_LABEL_KEY

See Also:

• Constant Field Values

NODE_OBSERVED_KEY

public static final String NODE_OBSERVED_KEY

See Also:

• Constant Field Values

NODE_PARAMETER_KEY

public static final String NODE_PARAMETER_KEY

See Also:

• Constant Field Values

NODE_POTENTIAL_KEY

public static final String NODE_POTENTIAL_KEY

See Also:

• Constant Field Values

NODE_X_KEY

public static final String NODE_X_KEY

See Also:

• Constant Field Values

NODE_Y_KEY

public static final String NODE_Y_KEY

See Also:

• Constant Field Values

LOG

static final Logger LOG

logger

layout

edu.uci.ics.jung.algorithms.layout.AbstractLayout<LabeledNode,? extends Edge> layout

networkType

TNGraph.NetworkType networkType

Graph type

Constructor Details

TNGraphMLWriter

public TNGraphMLWriter(edu.uci.ics.jung.algorithms.layout.AbstractLayout<LabeledNode,? extends Edge> lay)

Constructor for TNGraphMLWriter.

Parameters:

lay - a AbstractLayout object. If it is null, vertex coordinates are determined from the property of the vertex.

Method Details

save

public void save(TNGraph<? extends Edge> graph,
 File outputFile)
          throws IOException

Helper method for making GraphMLWriter.save(Hypergraph, Writer) easier.

Parameters:

graph - the network to save

outputFile - file object where to save the XML string representing the graph. File encoding is UTF8.

Throws:

IOException - if it is not possible to save to outputFile

save

public void save(TNGraph<? extends Edge> graph,
 Writer writer)
          throws IOException

Parameters:

graph - the graph to save

writer - the writer to use

Throws:

IOException - if the writer cannot write the file

save

public String save(TNGraph<? extends Edge> graph)

Helper method for making GraphMLWriter.save(Hypergraph, Writer) easier.

Parameters:

graph - the network to save

Returns:

a GraphML string representing the graph.