source: josm/trunk/src/org/openstreetmap/josm/actions/ExtensionFileFilter.java@ 10809

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

sonar - various fixes
  • Property svn:eol-style set to native
File size: 18.4 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import java.io.File;
5import java.util.ArrayList;
6import java.util.Arrays;
7import java.util.Collection;
8import java.util.Collections;
9import java.util.Comparator;
10import java.util.LinkedHashSet;
11import java.util.LinkedList;
12import java.util.List;
13import java.util.Objects;
14import java.util.ServiceConfigurationError;
15
16import javax.swing.filechooser.FileFilter;
17
18import org.openstreetmap.josm.Main;
19import org.openstreetmap.josm.gui.widgets.AbstractFileChooser;
20import org.openstreetmap.josm.io.AllFormatsImporter;
21import org.openstreetmap.josm.io.FileExporter;
22import org.openstreetmap.josm.io.FileImporter;
23import org.openstreetmap.josm.io.GpxImporter;
24import org.openstreetmap.josm.io.JpgImporter;
25import org.openstreetmap.josm.io.NMEAImporter;
26import org.openstreetmap.josm.io.NoteImporter;
27import org.openstreetmap.josm.io.OsmChangeImporter;
28import org.openstreetmap.josm.io.OsmImporter;
29import org.openstreetmap.josm.io.WMSLayerImporter;
30import org.openstreetmap.josm.io.session.SessionImporter;
31import org.openstreetmap.josm.tools.Utils;
32
33/**
34 * A file filter that filters after the extension. Also includes a list of file
35 * filters used in JOSM.
36 * @since 32
37 */
38public class ExtensionFileFilter extends FileFilter implements java.io.FileFilter {
39
40 /**
41 * List of supported formats for import.
42 * @since 4869
43 */
44 private static final ArrayList<FileImporter> importers;
45
46 /**
47 * List of supported formats for export.
48 * @since 4869
49 */
50 private static final ArrayList<FileExporter> exporters;
51
52 // add some file types only if the relevant classes are there.
53 // this gives us the option to painlessly drop them from the .jar
54 // and build JOSM versions without support for these formats
55
56 static {
57
58 importers = new ArrayList<>();
59
60 final List<Class<? extends FileImporter>> importerNames = Arrays.asList(
61 OsmImporter.class,
62 OsmChangeImporter.class,
63 GpxImporter.class,
64 NMEAImporter.class,
65 NoteImporter.class,
66 JpgImporter.class,
67 WMSLayerImporter.class,
68 AllFormatsImporter.class,
69 SessionImporter.class
70 );
71
72 for (final Class<? extends FileImporter> importerClass : importerNames) {
73 try {
74 FileImporter importer = importerClass.getConstructor().newInstance();
75 importers.add(importer);
76 } catch (ReflectiveOperationException e) {
77 Main.debug(e);
78 } catch (ServiceConfigurationError e) {
79 // error seen while initializing WMSLayerImporter in plugin unit tests:
80 // -
81 // ServiceConfigurationError: javax.imageio.spi.ImageWriterSpi:
82 // Provider com.sun.media.imageioimpl.plugins.jpeg.CLibJPEGImageWriterSpi could not be instantiated
83 // Caused by: java.lang.IllegalArgumentException: vendorName == null!
84 // at javax.imageio.spi.IIOServiceProvider.<init>(IIOServiceProvider.java:76)
85 // at javax.imageio.spi.ImageReaderWriterSpi.<init>(ImageReaderWriterSpi.java:231)
86 // at javax.imageio.spi.ImageWriterSpi.<init>(ImageWriterSpi.java:213)
87 // at com.sun.media.imageioimpl.plugins.jpeg.CLibJPEGImageWriterSpi.<init>(CLibJPEGImageWriterSpi.java:84)
88 // -
89 // This is a very strange behaviour of JAI:
90 // http://thierrywasyl.wordpress.com/2009/07/24/jai-how-to-solve-vendorname-null-exception/
91 // -
92 // that can lead to various problems, see #8583 comments
93 Main.error(e);
94 }
95 }
96
97 exporters = new ArrayList<>();
98
99 final List<Class<? extends FileExporter>> exporterClasses = Arrays.asList(
100 org.openstreetmap.josm.io.GpxExporter.class,
101 org.openstreetmap.josm.io.OsmExporter.class,
102 org.openstreetmap.josm.io.OsmGzipExporter.class,
103 org.openstreetmap.josm.io.OsmBzip2Exporter.class,
104 org.openstreetmap.josm.io.GeoJSONExporter.CurrentProjection.class, // needs to be considered earlier than GeoJSONExporter
105 org.openstreetmap.josm.io.GeoJSONExporter.class,
106 org.openstreetmap.josm.io.WMSLayerExporter.class,
107 org.openstreetmap.josm.io.NoteExporter.class
108 );
109
110 for (final Class<? extends FileExporter> exporterClass : exporterClasses) {
111 try {
112 FileExporter exporter = exporterClass.getConstructor().newInstance();
113 exporters.add(exporter);
114 Main.getLayerManager().addAndFireActiveLayerChangeListener(exporter);
115 } catch (ReflectiveOperationException e) {
116 Main.debug(e);
117 } catch (ServiceConfigurationError e) {
118 // see above in importers initialization
119 Main.error(e);
120 }
121 }
122 }
123
124 private final String extensions;
125 private final String description;
126 private final String defaultExtension;
127
128 protected static void sort(List<ExtensionFileFilter> filters) {
129 filters.sort(new Comparator<ExtensionFileFilter>() {
130 private AllFormatsImporter all = new AllFormatsImporter();
131 @Override
132 public int compare(ExtensionFileFilter o1, ExtensionFileFilter o2) {
133 if (o1.getDescription().equals(all.filter.getDescription())) return 1;
134 if (o2.getDescription().equals(all.filter.getDescription())) return -1;
135 return o1.getDescription().compareTo(o2.getDescription());
136 }
137 }
138 );
139 }
140
141 public enum AddArchiveExtension { NONE, BASE, ALL }
142
143 /**
144 * Adds a new file importer at the end of the global list. This importer will be evaluated after core ones.
145 * @param importer new file importer
146 * @since 10407
147 */
148 public static void addImporter(FileImporter importer) {
149 if (importer != null) {
150 importers.add(importer);
151 }
152 }
153
154 /**
155 * Adds a new file importer at the beginning of the global list. This importer will be evaluated before core ones.
156 * @param importer new file importer
157 * @since 10407
158 */
159 public static void addImporterFirst(FileImporter importer) {
160 if (importer != null) {
161 importers.add(0, importer);
162 }
163 }
164
165 /**
166 * Adds a new file exporter at the end of the global list. This exporter will be evaluated after core ones.
167 * @param exporter new file exporter
168 * @since 10407
169 */
170 public static void addExporter(FileExporter exporter) {
171 if (exporter != null) {
172 exporters.add(exporter);
173 }
174 }
175
176 /**
177 * Adds a new file exporter at the beginning of the global list. This exporter will be evaluated before core ones.
178 * @param exporter new file exporter
179 * @since 10407
180 */
181 public static void addExporterFirst(FileExporter exporter) {
182 if (exporter != null) {
183 exporters.add(0, exporter);
184 }
185 }
186
187 /**
188 * Returns the list of file importers.
189 * @return unmodifiable list of file importers
190 * @since 10407
191 */
192 public static List<FileImporter> getImporters() {
193 return Collections.unmodifiableList(importers);
194 }
195
196 /**
197 * Returns the list of file exporters.
198 * @return unmodifiable list of file exporters
199 * @since 10407
200 */
201 public static List<FileExporter> getExporters() {
202 return Collections.unmodifiableList(exporters);
203 }
204
205 /**
206 * Updates the {@link AllFormatsImporter} that is contained in the importers list. If
207 * you do not use the importers variable directly, you don’t need to call this.
208 * <p>
209 * Updating the AllFormatsImporter is required when plugins add new importers that
210 * support new file extensions. The old AllFormatsImporter doesn’t include the new
211 * extensions and thus will not display these files.
212 *
213 * @since 5131
214 */
215 public static void updateAllFormatsImporter() {
216 for (int i = 0; i < importers.size(); i++) {
217 if (importers.get(i) instanceof AllFormatsImporter) {
218 importers.set(i, new AllFormatsImporter());
219 }
220 }
221 }
222
223 /**
224 * Replies an ordered list of {@link ExtensionFileFilter}s for importing.
225 * The list is ordered according to their description, an {@link AllFormatsImporter}
226 * is append at the end.
227 *
228 * @return an ordered list of {@link ExtensionFileFilter}s for importing.
229 * @since 2029
230 */
231 public static List<ExtensionFileFilter> getImportExtensionFileFilters() {
232 updateAllFormatsImporter();
233 List<ExtensionFileFilter> filters = new LinkedList<>();
234 for (FileImporter importer : importers) {
235 filters.add(importer.filter);
236 }
237 sort(filters);
238 return filters;
239 }
240
241 /**
242 * Replies an ordered list of enabled {@link ExtensionFileFilter}s for exporting.
243 * The list is ordered according to their description, an {@link AllFormatsImporter}
244 * is append at the end.
245 *
246 * @return an ordered list of enabled {@link ExtensionFileFilter}s for exporting.
247 * @since 2029
248 */
249 public static List<ExtensionFileFilter> getExportExtensionFileFilters() {
250 List<ExtensionFileFilter> filters = new LinkedList<>();
251 for (FileExporter exporter : exporters) {
252 if (filters.contains(exporter.filter) || !exporter.isEnabled()) {
253 continue;
254 }
255 filters.add(exporter.filter);
256 }
257 sort(filters);
258 return filters;
259 }
260
261 /**
262 * Replies the default {@link ExtensionFileFilter} for a given extension
263 *
264 * @param extension the extension
265 * @return the default {@link ExtensionFileFilter} for a given extension
266 * @since 2029
267 */
268 public static ExtensionFileFilter getDefaultImportExtensionFileFilter(String extension) {
269 if (extension == null) return new AllFormatsImporter().filter;
270 for (FileImporter importer : importers) {
271 if (extension.equals(importer.filter.getDefaultExtension()))
272 return importer.filter;
273 }
274 return new AllFormatsImporter().filter;
275 }
276
277 /**
278 * Replies the default {@link ExtensionFileFilter} for a given extension
279 *
280 * @param extension the extension
281 * @return the default {@link ExtensionFileFilter} for a given extension
282 * @since 2029
283 */
284 public static ExtensionFileFilter getDefaultExportExtensionFileFilter(String extension) {
285 if (extension == null) return new AllFormatsImporter().filter;
286 for (FileExporter exporter : exporters) {
287 if (extension.equals(exporter.filter.getDefaultExtension()))
288 return exporter.filter;
289 }
290 // if extension did not match defaultExtension of any exporter,
291 // scan all supported extensions
292 File file = new File("file." + extension);
293 for (FileExporter exporter : exporters) {
294 if (exporter.filter.accept(file))
295 return exporter.filter;
296 }
297 return new AllFormatsImporter().filter;
298 }
299
300 /**
301 * Applies the choosable {@link FileFilter} to a {@link AbstractFileChooser} before using the
302 * file chooser for selecting a file for reading.
303 *
304 * @param fileChooser the file chooser
305 * @param extension the default extension
306 * @param allTypes If true, all the files types known by JOSM will be proposed in the "file type" combobox.
307 * If false, only the file filters that include {@code extension} will be proposed
308 * @since 5438
309 */
310 public static void applyChoosableImportFileFilters(AbstractFileChooser fileChooser, String extension, boolean allTypes) {
311 for (ExtensionFileFilter filter: getImportExtensionFileFilters()) {
312
313 if (allTypes || filter.acceptName("file."+extension)) {
314 fileChooser.addChoosableFileFilter(filter);
315 }
316 }
317 fileChooser.setFileFilter(getDefaultImportExtensionFileFilter(extension));
318 }
319
320 /**
321 * Applies the choosable {@link FileFilter} to a {@link AbstractFileChooser} before using the
322 * file chooser for selecting a file for writing.
323 *
324 * @param fileChooser the file chooser
325 * @param extension the default extension
326 * @param allTypes If true, all the files types known by JOSM will be proposed in the "file type" combobox.
327 * If false, only the file filters that include {@code extension} will be proposed
328 * @since 5438
329 */
330 public static void applyChoosableExportFileFilters(AbstractFileChooser fileChooser, String extension, boolean allTypes) {
331 for (ExtensionFileFilter filter: getExportExtensionFileFilters()) {
332 if (allTypes || filter.acceptName("file."+extension)) {
333 fileChooser.addChoosableFileFilter(filter);
334 }
335 }
336 fileChooser.setFileFilter(getDefaultExportExtensionFileFilter(extension));
337 }
338
339 /**
340 * Construct an extension file filter by giving the extension to check after.
341 * @param extension The comma-separated list of file extensions
342 * @param defaultExtension The default extension
343 * @param description A short textual description of the file type
344 * @since 1169
345 */
346 public ExtensionFileFilter(String extension, String defaultExtension, String description) {
347 this.extensions = extension;
348 this.defaultExtension = defaultExtension;
349 this.description = description;
350 }
351
352 /**
353 * Construct an extension file filter with the extensions supported by {@link org.openstreetmap.josm.io.Compression}
354 * automatically added to the {@code extensions}. The specified {@code extensions} will be added to the description
355 * in the form {@code old-description (*.ext1, *.ext2)}.
356 * @param extensions The comma-separated list of file extensions
357 * @param defaultExtension The default extension
358 * @param description A short textual description of the file type without supported extensions in parentheses
359 * @param addArchiveExtension Whether to also add the archive extensions to the description
360 * @param archiveExtensions List of extensions to be added
361 * @return The constructed filter
362 */
363 public static ExtensionFileFilter newFilterWithArchiveExtensions(String extensions, String defaultExtension,
364 String description, AddArchiveExtension addArchiveExtension, List<String> archiveExtensions) {
365 final Collection<String> extensionsPlusArchive = new LinkedHashSet<>();
366 final Collection<String> extensionsForDescription = new LinkedHashSet<>();
367 for (String e : extensions.split(",")) {
368 extensionsPlusArchive.add(e);
369 if (addArchiveExtension != AddArchiveExtension.NONE) {
370 extensionsForDescription.add("*." + e);
371 }
372 for (String extension : archiveExtensions) {
373 extensionsPlusArchive.add(e + '.' + extension);
374 if (addArchiveExtension == AddArchiveExtension.ALL) {
375 extensionsForDescription.add("*." + e + '.' + extension);
376 }
377 }
378 }
379 return new ExtensionFileFilter(
380 Utils.join(",", extensionsPlusArchive),
381 defaultExtension,
382 description + (!extensionsForDescription.isEmpty()
383 ? (" (" + Utils.join(", ", extensionsForDescription) + ')')
384 : "")
385 );
386 }
387
388 /**
389 * Construct an extension file filter with the extensions supported by {@link org.openstreetmap.josm.io.Compression}
390 * automatically added to the {@code extensions}. The specified {@code extensions} will be added to the description
391 * in the form {@code old-description (*.ext1, *.ext2)}.
392 * @param extensions The comma-separated list of file extensions
393 * @param defaultExtension The default extension
394 * @param description A short textual description of the file type without supported extensions in parentheses
395 * @param addArchiveExtensionsToDescription Whether to also add the archive extensions to the description
396 * @return The constructed filter
397 */
398 public static ExtensionFileFilter newFilterWithArchiveExtensions(
399 String extensions, String defaultExtension, String description, boolean addArchiveExtensionsToDescription) {
400
401 List<String> archiveExtensions = Arrays.asList("gz", "bz2");
402 return newFilterWithArchiveExtensions(
403 extensions,
404 defaultExtension,
405 description,
406 addArchiveExtensionsToDescription ? AddArchiveExtension.ALL : AddArchiveExtension.BASE,
407 archiveExtensions
408 );
409 }
410
411 /**
412 * Returns true if this file filter accepts the given filename.
413 * @param filename The filename to check after
414 * @return true if this file filter accepts the given filename (i.e if this filename ends with one of the extensions)
415 * @since 1169
416 */
417 public boolean acceptName(String filename) {
418 return Utils.hasExtension(filename, extensions.split(","));
419 }
420
421 @Override
422 public boolean accept(File pathname) {
423 if (pathname.isDirectory())
424 return true;
425 return acceptName(pathname.getName());
426 }
427
428 @Override
429 public String getDescription() {
430 return description;
431 }
432
433 /**
434 * Replies the comma-separated list of file extensions of this file filter.
435 * @return the comma-separated list of file extensions of this file filter, as a String
436 * @since 5131
437 */
438 public String getExtensions() {
439 return extensions;
440 }
441
442 /**
443 * Replies the default file extension of this file filter.
444 * @return the default file extension of this file filter
445 * @since 2029
446 */
447 public String getDefaultExtension() {
448 return defaultExtension;
449 }
450
451 @Override
452 public int hashCode() {
453 return Objects.hash(extensions, description, defaultExtension);
454 }
455
456 @Override
457 public boolean equals(Object obj) {
458 if (this == obj) return true;
459 if (obj == null || getClass() != obj.getClass()) return false;
460 ExtensionFileFilter that = (ExtensionFileFilter) obj;
461 return Objects.equals(extensions, that.extensions) &&
462 Objects.equals(description, that.description) &&
463 Objects.equals(defaultExtension, that.defaultExtension);
464 }
465}
Note: See TracBrowser for help on using the repository browser.