1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/* package-info.java
* =========================================================================
* This file is part of the GrInvIn project - http://www.grinvin.org
*
* Copyright (C) 2005-2008 Universiteit Gent
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program 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
* General Public License for more details.
*
* A copy of the GNU General Public License can be found in the file
* LICENSE.txt provided with the source distribution of this program (see
* the META-INF directory in the source jar). This license can also be
* found on the GNU website at http://www.gnu.org/licenses/gpl.html.
*
* If you did not receive a copy of the GNU General Public License along
* with this program, contact the lead developer, or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/
/**
* Provides classes for loading an saving graphs.<p>
*
* The classes {@link org.grinvin.io.GraphBundleLoader}
* and {@link org.grinvin.io.GraphBundleSaver} provide methods to load and save
* {@link org.grinvin.graphs.GraphBundle} objects from streams or files in
* <tt>gph</tt>-format, as described below.
*
* <h2>The <tt>gph</tt>-format</h2>
* A single graph bundle is stored as a (compressed) ZIP-archive containing
* a directory of XML-files, called <i>sections</i>.
* Currently the following sections are supported:
* <ul>
* <li>The section <a href="#meta-info><tt>meta-info.xml</tt></a>
* which contains information on the structure
* of the archive itself, e.g., version information.</li>
* <li>The section <a href="#resources><tt>resources.xml</tt></a> containing
* internationalized string resources for this graph bundle, e.g., the name of the
* graph.</li>
* <li>The section <a href="#graph"><tt>graph.xml</tt></a> with an abstract representation
* of the graph, e.g., which vertex is connected to which vertex.</li>
* <li>Sections with names of the form <a href="#embedding"><tt>embedding-*.xml</tt></a>
* which contain different embeddings of the graph,
* i.e., the list of coordinates to be assigned to the
* vertices of the abstract graph.</l>
* </ul>
* Entries can be stored in any order, although the above order is prefered and may
* load faster and use fewer memory resources.
*
* <a name="meta-info"><h2>Section <tt>meta-info.xml</tt></h2></a>
* Contains information on the structure of the archive itself. This section is stored
* as an XML properties document, as described in {@code java.util.Properties}.
* Currently the following properties are supported:
* <ul>
* <li><tt>version</tt>. Version of the format used in the
* form <i>major-nr</i>.<i>minor-nr</i>. The version described in this text
* is <tt>1.0</tt>.</li>
* <li><tt>nrOfEmbeddings</tt> (optional). The number of embeddings stored in
* this bundle. Can be omitted when zero.</li>
* </ul>
*
* <a name="resources"><h2>Section <tt>resources.xml</tt></h2></a>
* Internationalized string resources for this graph. Stored as an internationalized
* XML document, as described in {@link org.grinvin.util.InternationalizedProperties}.
* Refer to the documentation of
* {@link org.grinvin.graphs.GraphBundleView#getProperties} for a list of supported
* properties.
*
* <a name="graph"><h2>Section <tt>graph.xml</tt></h2></a>
* Representation of an abstract graph according to the following DTD:
* <pre>
* <!ELEMENT graph ( vertex*, edge* ) >
* <!ATTLIST graph nrofvertices CDATA #REQUIRED >
*
* <!ELEMENT vertex EMPTY >
* <!ATTLIST vertex id ID #REQUIRED >
* <!ATTLIST vertex annotation CDATA #IMPLIED >
*
* <!ELEMENT edge EMPTY >
* <!ATTLIST edge from IDREF #REQUIRED >
* <!ATTLIST edge to IDREF #REQUIRED >
* <!ATTLIST edge annotation CDATA #IMPLIED >
* </pre>
* Vertices are implicitly numbered from 0 upto <tt>nrofvertices</tt>-1.
* This sequence number is used as an id for the vertex. Vertices without annotations
* need not be explicitly present as elements.
*
* <a name="embedding"><h2>Sections <tt>embedding_0.xml</tt>,
* <tt>embedding_1.xml</tt>, ...</h2></a>
* Zero or more consecutively numbered embeddings fo the graph. Each embedding is
* stored according to the following DTD:
* <pre>
* <!ELEMENT embedding ( coordinates* ) >
* <!ATTLIST graph dimension CDATA #REQUIRED >
*
* <!ELEMENT coordinates ( double ) >
* <!ATTLIST coordinates id IDREF #REQUIRED >
*
* <!ELEMENT double EMPTY >
* <!ATTLIST double value CDATA #REQUIRED >
* </pre>
* Each <tt>coordinates</tt> element refers to the corresponding vertex by
* using the corresponding id from the <tt>graph.xml</tt> section.
*/
package org.grinvin.io;
|
