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

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

update javadoc + checkstyle fix + update presets links
  • Property svn:eol-style set to native
File size: 11.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 public static class MapRendererFactoryException extends RuntimeException {
47
48 public MapRendererFactoryException(String message, Throwable cause) {
49 super(message, cause);
50 }
51
52 public MapRendererFactoryException(String message) {
53 super(message);
54 }
55
56 public MapRendererFactoryException(Throwable cause) {
57 super(cause);
58 }
59 }
60
61 public static class Descriptor {
62 private Class<? extends AbstractMapRenderer> renderer;
63 private String displayName;
64 private String description;
65
66 public Descriptor(Class<? extends AbstractMapRenderer> renderer, String displayName, String description) {
67 this.renderer = renderer;
68 this.displayName = displayName;
69 this.description = description;
70 }
71
72 public Class<? extends AbstractMapRenderer> getRenderer() {
73 return renderer;
74 }
75
76 public String getDisplayName() {
77 return displayName;
78 }
79
80 public String getDescription() {
81 return description;
82 }
83 }
84
85 private static MapRendererFactory instance;
86
87 /**
88 * Replies the unique instance
89 * @return instance of map rending class
90 */
91 public static synchronized MapRendererFactory getInstance() {
92 if (instance == null) {
93 instance = new MapRendererFactory();
94 }
95 return instance;
96 }
97
98 private static Class<?> loadRendererClass(String className) {
99 for (ClassLoader cl : PluginHandler.getResourceClassLoaders()) {
100 try {
101 return Class.forName(className, true, cl);
102 } catch (final NoClassDefFoundError | ClassNotFoundException e) {
103 Main.trace(e.getMessage());
104 }
105 }
106 Main.error(tr("Failed to load map renderer class ''{0}''. The class wasn''t found.", className));
107 return null;
108 }
109
110 private final List<Descriptor> descriptors = new ArrayList<>();
111 private Class<? extends AbstractMapRenderer> activeRenderer;
112
113 private MapRendererFactory() {
114 registerDefaultRenderers();
115 String rendererClassName = Main.pref.get(PREF_KEY_RENDERER_CLASS_NAME, null);
116 if (rendererClassName != null) {
117 activateMapRenderer(rendererClassName);
118 } else {
119 activateDefault();
120 }
121 }
122
123 private void activateMapRenderer(String rendererClassName) {
124 Class<?> c = loadRendererClass(rendererClassName);
125 if (c == null) {
126 Main.error(tr("Can''t activate map renderer class ''{0}'', because the class wasn''t found.", rendererClassName));
127 Main.error(tr("Activating the standard map renderer instead."));
128 activateDefault();
129 } else if (!AbstractMapRenderer.class.isAssignableFrom(c)) {
130 Main.error(tr("Can''t activate map renderer class ''{0}'', because it isn''t a subclass of ''{1}''.",
131 rendererClassName, AbstractMapRenderer.class.getName()));
132 Main.error(tr("Activating the standard map renderer instead."));
133 activateDefault();
134 } else {
135 Class<? extends AbstractMapRenderer> renderer = c.asSubclass(AbstractMapRenderer.class);
136 if (!isRegistered(renderer)) {
137 Main.error(tr("Can''t activate map renderer class ''{0}'', because it isn''t registered as map renderer.", rendererClassName));
138 Main.error(tr("Activating the standard map renderer instead."));
139 activateDefault();
140 } else {
141 activate(renderer);
142 }
143 }
144 }
145
146 private void registerDefaultRenderers() {
147 register(
148 WireframeMapRenderer.class,
149 tr("Wireframe Map Renderer"),
150 tr("Renders the map as simple wire frame.")
151 );
152 register(
153 StyledMapRenderer.class,
154 tr("Styled Map Renderer"),
155 tr("Renders the map using style rules in a set of style sheets.")
156 );
157 }
158
159 /**
160 * <p>Replies true, if {@code Renderer} is already a registered map renderer
161 * class.</p>
162 *
163 * @param renderer the map renderer class. Must not be null.
164 * @return true, if {@code Renderer} is already a registered map renderer
165 * class
166 * @throws IllegalArgumentException if {@code renderer} is null
167 */
168 public boolean isRegistered(Class<? extends AbstractMapRenderer> renderer) {
169 CheckParameterUtil.ensureParameterNotNull(renderer);
170 for (Descriptor d: descriptors) {
171 if (d.getRenderer().getName().equals(renderer.getName())) return true;
172 }
173 return false;
174 }
175
176 /**
177 * <p>Registers a map renderer class.</p>
178 *
179 * @param renderer the map renderer class. Must not be null.
180 * @param displayName the display name to be displayed in UIs (i.e. in the preference dialog)
181 * @param description the description
182 * @throws IllegalArgumentException if {@code renderer} is null
183 * @throws IllegalStateException if {@code renderer} is already registered
184 */
185 public void register(Class<? extends AbstractMapRenderer> renderer, String displayName, String description) {
186 CheckParameterUtil.ensureParameterNotNull(renderer);
187 if (isRegistered(renderer))
188 throw new IllegalStateException(
189 // no I18n - this is a technical message
190 MessageFormat.format("Class ''{0}'' already registered a renderer", renderer.getName())
191 );
192 Descriptor d = new Descriptor(renderer, displayName, description);
193 descriptors.add(d);
194 }
195
196
197 /**
198 * <p>Unregisters a map renderer class.</p>
199 *
200 * <p>If the respective class is also the active renderer, the renderer is reset
201 * to the default renderer.</p>
202 *
203 * @param renderer the map renderer class. Must not be null.
204 *
205 */
206 public void unregister(Class<? extends AbstractMapRenderer> renderer) {
207 if (renderer == null) return;
208 if (!isRegistered(renderer)) return;
209 Iterator<Descriptor> it = descriptors.iterator();
210 while (it.hasNext()) {
211 Descriptor d = it.next();
212 if (d.getRenderer().getName().equals(renderer.getName())) {
213 it.remove();
214 break;
215 }
216 }
217 if (activeRenderer != null && activeRenderer.getName().equals(renderer.getName())) {
218 activateDefault();
219 }
220 }
221
222 /**
223 * <p>Activates a map renderer class.</p>
224 *
225 * <p>The renderer class must already be registered.</p>
226 *
227 * @param renderer the map renderer class. Must not be null.
228 * @throws IllegalArgumentException if {@code renderer} is null
229 * @throws IllegalStateException if {@code renderer} isn't registered yet
230 */
231 public void activate(Class<? extends AbstractMapRenderer> renderer) {
232 CheckParameterUtil.ensureParameterNotNull(renderer);
233 if (!isRegistered(renderer))
234 throw new IllegalStateException(
235 // no I18n required
236 MessageFormat.format("Class ''{0}'' not registered as renderer. Can''t activate it.", renderer.getName())
237 );
238 this.activeRenderer = renderer;
239 Main.pref.put(PREF_KEY_RENDERER_CLASS_NAME, activeRenderer.getName());
240
241 }
242
243 /**
244 * <p>Activates the default map renderer.</p>
245 *
246 * @throws IllegalStateException if the default renderer {@link StyledMapRenderer} isn't registered
247 */
248 public void activateDefault() {
249 Class<? extends AbstractMapRenderer> defaultRenderer = StyledMapRenderer.class;
250 if (!isRegistered(defaultRenderer))
251 throw new IllegalStateException(
252 MessageFormat.format("Class ''{0}'' not registered as renderer. Can''t activate default renderer.",
253 defaultRenderer.getName())
254 );
255 activate(defaultRenderer);
256 }
257
258 /**
259 * <p>Creates an instance of the currently active renderer.</p>
260 * @return an instance of the currently active renderer
261 *
262 * @throws MapRendererFactoryException if creating an instance fails
263 * @see AbstractMapRenderer#AbstractMapRenderer(Graphics2D, NavigatableComponent, boolean)
264 */
265 public AbstractMapRenderer createActiveRenderer(Graphics2D g, NavigatableComponent viewport, boolean isInactiveMode)
266 throws MapRendererFactoryException {
267 try {
268 Constructor<?> c = activeRenderer.getConstructor(new Class<?>[]{Graphics2D.class, NavigatableComponent.class, boolean.class});
269 return AbstractMapRenderer.class.cast(c.newInstance(g, viewport, isInactiveMode));
270 } catch (NoSuchMethodException | IllegalArgumentException | InstantiationException | IllegalAccessException e) {
271 throw new MapRendererFactoryException(e);
272 } catch (InvocationTargetException e) {
273 throw new MapRendererFactoryException(e.getCause());
274 }
275 }
276
277 /**
278 * <p>Replies the (unmodifiable) list of map renderer descriptors.</p>
279 *
280 * @return the descriptors
281 */
282 public List<Descriptor> getMapRendererDescriptors() {
283 return Collections.unmodifiableList(descriptors);
284 }
285
286 /**
287 * <p>Replies true, if currently the wireframe map renderer is active. Otherwise,
288 * false.</p>
289 *
290 * <p>There is a specific method for {@link WireframeMapRenderer} for legacy support.
291 * Until 03/2011 there were only two possible map renderers in JOSM: the wireframe
292 * renderer and the styled renderer. For the time being there are still UI elements
293 * (menu entries, etc.) which toggle between these two renderers only.</p>
294 *
295 * @return true, if currently the wireframe map renderer is active. Otherwise,
296 * false
297 */
298 public boolean isWireframeMapRendererActive() {
299 return activeRenderer != null && activeRenderer.getName().equals(WireframeMapRenderer.class.getName());
300 }
301}
Note: See TracBrowser for help on using the repository browser.