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
|
/* GraphBundle.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.
*/
package org.grinvin.graphs;
import org.grinvin.gui.icons.GraphIconFactory;
import org.grinvin.invariants.InvariantValue;
import org.grinvin.util.InternationalizedProperties;
/**
* A mutable version of {@link GraphBundleView}. Provides methods to store
* or change information contained in a bundle.
*/
public interface GraphBundle extends GraphBundleView {
/**
* Abstract graph representation for this graph bundle.
*/
public Graph getGraph();
/**
* Set the internationalized properties for this graph.
*/
public void setProperties(InternationalizedProperties properties);
/**
* Factory method which creates a new (empty) graph for this bundle.
* Subsequent calls to {@link #getGraph} should return this graph.
* @return the graph created
*/
public Graph createGraph();
/**
* Factory method which creates a new (empty) embedding
* and installs it as the next embedding in this bundle, i.e., the embedding
* with the next available index.<p>
* This embedding should have the graph returned by {@link #getGraph}
* as a peer. Subsequent calls to {@link #getEmbedding} with the appropriate
* index, should return the embedding created by this method.
* @return the embedding created or null when the graph bundle does not support embeddings.
*/
public Embedding createEmbedding();
/**
* Factory method which creates a new (empty) annotation and installs it as
* the next annotation in this bundle, i.e., the annotation with the next
* available index.<p>
* This annotation should have the graph returned by {@link #getGraph}
* as a peer. Subsequent calls to {@link #getAnnotation} with the appropriate
* index, should return the annotation created by this method.
* @return the annotation created or null when the graph bundle does not support annotations.
*/
public Annotation createAnnotation();
/**
* Add the given InvariantValue as a cached value to this bundle
* @param value The InvariantValue to be added to this bundle.
*/
public void addInvariantValue(InvariantValue value);
/**
* Clear all cached values for this bundle (i.e. cached InvariantValues
* and other cached values such as eigenvalues, adjacency lists,...).
*/
public void invalidate();
/**
* Remove the given InvariantValue from the cache of this bundle.
* @param value The InvariantValue to be removed from this bundle.
*/
public void invalidate(InvariantValue value);
/**
* Set the graph icon factory used for displaying this graph as
* an icon.
*/
public void setGraphIconFactory(GraphIconFactory graphIconFactory);
//
public void addGraphBundleListener(GraphBundleListener listener);
//
public void removeGraphBundleListener(GraphBundleListener listener);
}
|
