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

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

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