blob: c799dea98a393352b5f8ca148a82746add5d39bd (
plain)
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
package de.lmu.ifi.dbs.elki.visualization.css;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import java.util.Collection;
import java.util.HashMap;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
import de.lmu.ifi.dbs.elki.visualization.svg.SVGUtil;
/**
* Manager class to track CSS classes used in a particular SVG document.
*
* @author Erich Schubert
* @since 0.2
*
* @apiviz.has de.lmu.ifi.dbs.elki.visualization.css.CSSClass
*/
public class CSSClassManager {
/**
* Store the contained CSS classes.
*/
private HashMap<String, CSSClass> store = new HashMap<>();
/**
* Add a single class to the map.
*
* @param clss new CSS class
* @return existing (old) class
* @throws CSSNamingConflict when a class of the same name but different owner object exists.
*/
public CSSClass addClass(CSSClass clss) throws CSSNamingConflict {
CSSClass existing = store.get(clss.getName());
if (existing != null && existing.getOwner() != null && existing.getOwner() != clss.getOwner()) {
throw new CSSNamingConflict("CSS class naming conflict between "+clss.getOwner().toString()+" and "+existing.getOwner().toString());
}
return store.put(clss.getName(), clss);
}
/**
* Remove a single CSS class from the map.
* Note that classes are removed by reference, not by name!
*
* @param clss Class to remove
*/
public synchronized void removeClass(CSSClass clss) {
CSSClass existing = store.get(clss.getName());
if (existing == clss) {
store.remove(existing.getName());
}
}
/**
* Retrieve a single class by name and owner
*
* @param name Class name
* @param owner Class owner
* @return existing (old) class
* @throws CSSNamingConflict if an owner was specified and doesn't match
*/
public CSSClass getClass(String name, Object owner) throws CSSNamingConflict {
CSSClass existing = store.get(name);
// Not found.
if (existing == null) {
return null;
}
// Different owner
if (owner != null && existing.getOwner() != owner) {
throw new CSSNamingConflict("CSS class naming conflict between "+owner.toString()+" and "+existing.getOwner().toString());
}
return existing;
}
/**
* Retrieve a single class by name only
*
* @param name CSS class name
* @return existing (old) class
*/
public CSSClass getClass(String name) {
return store.get(name);
}
/**
* Check if a name is already used in the classes.
*
* @param name CSS class name
* @return true if the class name is already used.
*/
public boolean contains(String name) {
return store.containsKey(name);
}
/**
* Serialize managed CSS classes to rule file.
*
* @param buf String buffer
*/
public void serialize(StringBuilder buf) {
for (CSSClass clss : store.values()) {
clss.appendCSSDefinition(buf);
}
}
/**
* Get all CSS classes in this manager.
*
* @return CSS classes.
*/
public Collection<CSSClass> getClasses() {
return store.values();
}
/**
* Check whether or not CSS classes of two plots can be merged
*
* @param other Other class
* @return true if able to merge
*/
public boolean testMergeable(CSSClassManager other) {
for (CSSClass clss : other.getClasses()) {
CSSClass existing = store.get(clss.getName());
// Check for a naming conflict.
if (existing != null && existing.getOwner() != null && clss.getOwner() != null && existing.getOwner() != clss.getOwner()) {
return false;
}
}
return true;
}
/**
* Merge CSS classes, for example to merge two plots.
*
* @param other Other class to merge with
* @return success code
* @throws CSSNamingConflict If there is a naming conflict.
*/
public boolean mergeCSSFrom(CSSClassManager other) throws CSSNamingConflict {
for (CSSClass clss : other.getClasses()) {
this.addClass(clss);
}
return true;
}
/**
* Class to signal a CSS naming conflict.
*
* @apiviz.exclude
*/
public class CSSNamingConflict extends Exception {
/**
* Serial version UID
*/
private static final long serialVersionUID = 4163822727195636747L;
/**
* Exception to signal a CSS naming conflict.
*
* @param msg Exception message
*/
public CSSNamingConflict(String msg) {
super(msg);
}
}
/**
* Update the text contents of an existing style element.
*
* @param document Document element (factory)
* @param style Style element
*/
public void updateStyleElement(Document document, Element style) {
StringBuilder buf = new StringBuilder();
serialize(buf);
Text cont = document.createTextNode(buf.toString());
while (style.hasChildNodes()) {
style.removeChild(style.getFirstChild());
}
style.appendChild(cont);
}
/**
* Make a (filled) CSS style element for the given document.
*
* @param document Document
* @return Style element
*/
public Element makeStyleElement(Document document) {
Element style = SVGUtil.makeStyleElement(document);
updateStyleElement(document, style);
return style;
}
}
|
