source: josm/trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/MapRendererFactory.java@ 12279

Last change on this file since 12279 was 12279, checked in by Don-vip, 7 years ago

sonar - squid:S3878 - Arrays should not be created for varargs parameters
  • Property svn:eol-style set to native
File size: 12.3 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.data.osm.visitor.paint;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Graphics2D;
7import java.lang.reflect.Constructor;
8import java.lang.reflect.InvocationTargetException;
9import java.text.MessageFormat;
10import java.util.ArrayList;
11import java.util.Collections;
12import java.util.Iterator;
13import java.util.List;
14
15import org.openstreetmap.josm.Main;
16import org.openstreetmap.josm.gui.NavigatableComponent;
17import org.openstreetmap.josm.plugins.PluginHandler;
18import org.openstreetmap.josm.tools.CheckParameterUtil;
19
20/**
21 * <p>MapRendererFactory manages a list of map renderer classes and associated
22 * meta data (display name, description).</p>
23 *
24 * <p>Plugins can implement and supply their own map renderers.</p>
25 * <strong>Sample code in a plugin</strong>
26 * <pre>
27 * public class MyMapRenderer extends AbstractMapRenderer {
28 * // ....
29 * }
30 *
31 * // to be called when the plugin is created
32 * MapRendererFactory factory = MapRendererFactory.getInstance();
33 * factory.register(MyMapRenderer.class, "My map renderer", "This is is a fast map renderer");
34 * factory.activate(MyMapRenderer.class);
35 *
36 * </pre>
37 * @since 4087
38 */
39public final class MapRendererFactory {
40
41 /** preference key for the renderer class name. Default: class name for {@link StyledMapRenderer}
42 *
43 */
44 public static final String PREF_KEY_RENDERER_CLASS_NAME = "mappaint.renderer-class-name";
45
46 /**
47 * An exception thrown while creating a map renderer
48 */
49 public static class MapRendererFactoryException extends RuntimeException {
50
51 /**
52 * Create a new {@link MapRendererFactoryException}
53 * @param message The message
54 * @param cause The cause
55 */
56 public MapRendererFactoryException(String message, Throwable cause) {
57 super(message, cause);
58 }
59
60 /**
61 * Create a new {@link MapRendererFactoryException}
62 * @param message The message
63 */
64 public MapRendererFactoryException(String message) {
65 super(message);
66 }
67
68 /**
69 * Create a new {@link MapRendererFactoryException}
70 * @param cause The cause
71 */
72 public MapRendererFactoryException(Throwable cause) {
73 super(cause);
74 }
75 }
76
77 /**
78 * A description of a possible renderer for the map
79 */
80 public static class Descriptor {
81 private final Class<? extends AbstractMapRenderer> renderer;
82 private final String displayName;
83 private final String description;
84
85 /**
86 * Creates a new map renderer description
87 * @param renderer The renderer
88 * @param displayName The display name for the renderer
89 * @param description The longer description that should be displayed to the user.
90 */
91 public Descriptor(Class<? extends AbstractMapRenderer> renderer, String displayName, String description) {
92 this.renderer = renderer;
93 this.displayName = displayName;
94 this.description = description;
95 }
96
97 /**
98 * Get the class of the renderer
99 * @return The class
100 */
101 public Class<? extends AbstractMapRenderer> getRenderer() {
102 return renderer;
103 }
104
105 /**
106 * Get the display name
107 * @return The name
108 */
109 public String getDisplayName() {
110 return displayName;
111 }
112
113 /**
114 * Get the description
115 * @return The description
116 */
117 public String getDescription() {
118 return description;
119 }
120 }
121
122 private static MapRendererFactory instance;
123
124 /**
125 * Replies the unique instance
126 * @return instance of map rending class
127 */
128 public static synchronized MapRendererFactory getInstance() {
129 if (instance == null) {
130 instance = new MapRendererFactory();
131 }
132 return instance;
133 }
134
135 private static Class<?> loadRendererClass(String className) {
136 for (ClassLoader cl : PluginHandler.getResourceClassLoaders()) {
137 try {
138 return Class.forName(className, true, cl);
139 } catch (final NoClassDefFoundError | ClassNotFoundException e) {
140 Main.trace(e);
141 }
142 }
143 Main.error(tr("Failed to load map renderer class ''{0}''. The class wasn''t found.", className));
144 return null;
145 }
146
147 private final List<Descriptor> descriptors = new ArrayList<>();
148 private Class<? extends AbstractMapRenderer> activeRenderer;
149
150 private MapRendererFactory() {
151 registerDefaultRenderers();
152 String rendererClassName = Main.pref.get(PREF_KEY_RENDERER_CLASS_NAME, null);
153 if (rendererClassName != null) {
154 activateMapRenderer(rendererClassName);
155 } else {
156 activateDefault();
157 }
158 }
159
160 private void activateMapRenderer(String rendererClassName) {
161 Class<?> c = loadRendererClass(rendererClassName);
162 if (c == null) {
163 Main.error(tr("Can''t activate map renderer class ''{0}'', because the class wasn''t found.", rendererClassName));
164 Main.error(tr("Activating the standard map renderer instead."));
165 activateDefault();
166 } else if (!AbstractMapRenderer.class.isAssignableFrom(c)) {
167 Main.error(tr("Can''t activate map renderer class ''{0}'', because it isn''t a subclass of ''{1}''.",
168 rendererClassName, AbstractMapRenderer.class.getName()));
169 Main.error(tr("Activating the standard map renderer instead."));
170 activateDefault();
171 } else {
172 Class<? extends AbstractMapRenderer> renderer = c.asSubclass(AbstractMapRenderer.class);
173 if (!isRegistered(renderer)) {
174 Main.error(tr("Can''t activate map renderer class ''{0}'', because it isn''t registered as map renderer.", rendererClassName));
175 Main.error(tr("Activating the standard map renderer instead."));
176 activateDefault();
177 } else {
178 activate(renderer);
179 }
180 }
181 }
182
183 private void registerDefaultRenderers() {
184 register(
185 WireframeMapRenderer.class,
186 tr("Wireframe Map Renderer"),
187 tr("Renders the map as simple wire frame.")
188 );
189 register(
190 StyledMapRenderer.class,
191 tr("Styled Map Renderer"),
192 tr("Renders the map using style rules in a set of style sheets.")
193 );
194 }
195
196 /**
197 * <p>Replies true, if {@code Renderer} is already a registered map renderer class.</p>
198 *
199 * @param renderer the map renderer class. Must not be null.
200 * @return true, if {@code Renderer} is already a registered map renderer class
201 * @throws IllegalArgumentException if {@code renderer} is null
202 */
203 public boolean isRegistered(Class<? extends AbstractMapRenderer> renderer) {
204 CheckParameterUtil.ensureParameterNotNull(renderer);
205 for (Descriptor d: descriptors) {
206 if (d.getRenderer().equals(renderer)) return true;
207 }
208 return false;
209 }
210
211 /**
212 * <p>Registers a map renderer class.</p>
213 *
214 * @param renderer the map renderer class. Must not be null.
215 * @param displayName the display name to be displayed in UIs (i.e. in the preference dialog)
216 * @param description the description
217 * @throws IllegalArgumentException if {@code renderer} is null
218 * @throws IllegalStateException if {@code renderer} is already registered
219 */
220 public void register(Class<? extends AbstractMapRenderer> renderer, String displayName, String description) {
221 CheckParameterUtil.ensureParameterNotNull(renderer);
222 if (isRegistered(renderer))
223 throw new IllegalStateException(
224 // no I18n - this is a technical message
225 MessageFormat.format("Class ''{0}'' already registered a renderer", renderer.getName())
226 );
227 Descriptor d = new Descriptor(renderer, displayName, description);
228 descriptors.add(d);
229 }
230
231
232 /**
233 * <p>Unregisters a map renderer class.</p>
234 *
235 * <p>If the respective class is also the active renderer, the renderer is reset
236 * to the default renderer.</p>
237 *
238 * @param renderer the map renderer class. Must not be null.
239 *
240 */
241 public void unregister(Class<? extends AbstractMapRenderer> renderer) {
242 if (renderer == null) return;
243 if (!isRegistered(renderer)) return;
244 Iterator<Descriptor> it = descriptors.iterator();
245 while (it.hasNext()) {
246 Descriptor d = it.next();
247 if (d.getRenderer().equals(renderer)) {
248 it.remove();
249 break;
250 }
251 }
252 if (activeRenderer != null && activeRenderer.equals(renderer)) {
253 activateDefault();
254 }
255 }
256
257 /**
258 * <p>Activates a map renderer class.</p>
259 *
260 * <p>The renderer class must already be registered.</p>
261 *
262 * @param renderer the map renderer class. Must not be null.
263 * @throws IllegalArgumentException if {@code renderer} is null
264 * @throws IllegalStateException if {@code renderer} isn't registered yet
265 */
266 public void activate(Class<? extends AbstractMapRenderer> renderer) {
267 CheckParameterUtil.ensureParameterNotNull(renderer);
268 if (!isRegistered(renderer))
269 throw new IllegalStateException(
270 // no I18n required
271 MessageFormat.format("Class ''{0}'' not registered as renderer. Can''t activate it.", renderer.getName())
272 );
273 this.activeRenderer = renderer;
274 Main.pref.put(PREF_KEY_RENDERER_CLASS_NAME, activeRenderer.getName());
275
276 }
277
278 /**
279 * <p>Activates the default map renderer.</p>
280 *
281 * @throws IllegalStateException if the default renderer {@link StyledMapRenderer} isn't registered
282 */
283 public void activateDefault() {
284 Class<? extends AbstractMapRenderer> defaultRenderer = StyledMapRenderer.class;
285 if (!isRegistered(defaultRenderer))
286 throw new IllegalStateException(
287 MessageFormat.format("Class ''{0}'' not registered as renderer. Can''t activate default renderer.",
288 defaultRenderer.getName())
289 );
290 activate(defaultRenderer);
291 }
292
293 /**
294 * <p>Creates an instance of the currently active renderer.</p>
295 * @param g Graphics
296 * @param viewport Navigatable component
297 * @param isInactiveMode {@code true} if the paint visitor shall render OSM objects such that they look inactive
298 * @return an instance of the currently active renderer
299 *
300 * @throws MapRendererFactoryException if creating an instance fails
301 * @see AbstractMapRenderer#AbstractMapRenderer(Graphics2D, NavigatableComponent, boolean)
302 */
303 public AbstractMapRenderer createActiveRenderer(Graphics2D g, NavigatableComponent viewport, boolean isInactiveMode) {
304 try {
305 Constructor<?> c = activeRenderer.getConstructor(Graphics2D.class, NavigatableComponent.class, boolean.class);
306 return AbstractMapRenderer.class.cast(c.newInstance(g, viewport, isInactiveMode));
307 } catch (InvocationTargetException e) {
308 Main.debug(e);
309 throw new MapRendererFactoryException(e.getCause());
310 } catch (ReflectiveOperationException | IllegalArgumentException e) {
311 throw new MapRendererFactoryException(e);
312 }
313 }
314
315 /**
316 * <p>Replies the (unmodifiable) list of map renderer descriptors.</p>
317 *
318 * @return the descriptors
319 */
320 public List<Descriptor> getMapRendererDescriptors() {
321 return Collections.unmodifiableList(descriptors);
322 }
323
324 /**
325 * <p>Replies true, if currently the wireframe map renderer is active. Otherwise, false.</p>
326 *
327 * <p>There is a specific method for {@link WireframeMapRenderer} for legacy support.
328 * Until 03/2011 there were only two possible map renderers in JOSM: the wireframe
329 * renderer and the styled renderer. For the time being there are still UI elements
330 * (menu entries, etc.) which toggle between these two renderers only.</p>
331 *
332 * @return true, if currently the wireframe map renderer is active. Otherwise, false
333 */
334 public boolean isWireframeMapRendererActive() {
335 return WireframeMapRenderer.class.equals(activeRenderer);
336 }
337}
Note: See TracBrowser for help on using the repository browser.