jas.graph
Class GraphML

java.lang.Object
  jas.graph.GraphML

public class GraphML
extends java.lang.Object

The GraphML can be used to save and load graphs. The GraphML class does only support graphs from the org._3pq.jgrapht.Graph hierarchy. The file format is based on the GraphML standard format, as defined at http://graphml.graphdrawing.org/specification/dtd.html.
How to save graphs.
In order to save a graph, you have to check your graph inherits from the root org._3pq.jgrapht.Graph class and all the nodes (vertexes) of the graph implement the jas.graph.IRelationalAgent.
In addition to the standard required GraphML structure, the resulting xml file will contains some specific attributes of the IRelationalAgent interface.
Each node will contain a label and (x, y) coordinates. In addition, the user can add custom values to attributes map. The attributes' type must be one of the following:

• Boolean
• Integer
• Double
• Long
• Float
• String

Any other type will be ignored.

How to load graphs.
The GraphML class is able to parse a standard GraphML formatted file and creates a org._3pq.jgrapht.DirectedWeightedMultigraph. All the nodes are RelationalAgent instances. If you want to create different kind of graph or different nodes, you have to create a class implementing the IGraphMLCreator, which will be delegated to create objects. See the jas.graph.IGraphMLCreator for mode details.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Constructor Summary

GraphML()
Create a new instance of the GraphML using the default vertex creator.

GraphML(IGraphMLCreator creator)
Create a new instance of the GraphML using the given vertex creator.

Method Summary

org._3pq.jgrapht.Graph	load(IGraphMLCreator creator, java.lang.String filename) Parse a GraphML (file) and return a jas.graph compliant graph.
org._3pq.jgrapht.Graph	load(java.lang.String filename) Parse a GraphML (file) and return a jas.graph compliant graph.
void	save(org._3pq.jgrapht.Graph g, java.lang.String outFile) Save the given graph to the specified file, using the GraphML format.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphML

public GraphML()

Create a new instance of the GraphML using the default vertex creator.

GraphML

public GraphML(IGraphMLCreator creator)

Create a new instance of the GraphML using the given vertex creator.

Parameters:

creator - Is a class implementing the IGraphMLCreator interface. It is delegated the creation of the graph objects during the loading of an xml file.

Method Detail

load

public org._3pq.jgrapht.Graph load(IGraphMLCreator creator,
                                   java.lang.String filename)

Parse a GraphML (file) and return a jas.graph compliant graph.

Parameters:

creator - A class implementing the IGraphMLCreator interface. It is delegated the creation of the graph objects during the loading of an xml file.

filename - The xml file containing the graph description.

Returns:

The graph built using the xml source file.

load

public org._3pq.jgrapht.Graph load(java.lang.String filename)

Parse a GraphML (file) and return a jas.graph compliant graph.

Parameters:

filename - The xml file containing the graph description.

Returns:

The graph built using the xml source file.

save

public void save(org._3pq.jgrapht.Graph g,
                 java.lang.String outFile)

Save the given graph to the specified file, using the GraphML format.

Parameters:

g - The graph to be saved.

outFile - The target file.