Package org.openstreetmap.josm.gui.io.importexport

Class FileExporter

java.lang.Object

org.openstreetmap.josm.gui.io.importexport.FileExporter

All Implemented Interfaces:

MainLayerManager.ActiveLayerChangeListener

Direct Known Subclasses:

GeoJSONExporter, GpxExporter, NoteExporter, OsmExporter, ValidatorErrorExporter, WMSLayerExporter

public abstract class FileExporter
extends java.lang.Object
implements MainLayerManager.ActiveLayerChangeListener

Abstract base class for file exporters - IO classes that save layers to a file.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	canceled
private boolean	enabled
ExtensionFileFilter	filter	the ExtensionFileFilter filter used by this exporter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileExporter(ExtensionFileFilter filter)	Constructs a new FileExporter.

Method Summary

Modifier and Type	Method	Description
boolean	acceptFile(java.io.File pathname, Layer layer)	Check if this exporter can export a certain layer to a certain file.
void	activeOrEditLayerChanged(MainLayerManager.ActiveLayerChangeEvent e)	Called whenever the active or edit layer changed.
void	exportData(java.io.File file, Layer layer)	Execute the data export.
void	exportDataQuiet(java.io.File file, Layer layer)	Execute the data export without prompting the user.
boolean	isCanceled()	Determines if this exporter has been canceled during export.
boolean	isEnabled()	Returns the enabled state of this FileExporter.
void	setCanceled(boolean canceled)	Marks this exporter as canceled.
void	setEnabled(boolean enabled)	Sets the enabled state of the FileExporter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

filter

public final ExtensionFileFilter filter

the ExtensionFileFilter filter used by this exporter

enabled

private boolean enabled

canceled

private boolean canceled

Constructor Detail

FileExporter

protected FileExporter(ExtensionFileFilter filter)

Constructs a new FileExporter.

Parameters:

filter - The extension file filter

Method Detail

acceptFile

public boolean acceptFile(java.io.File pathname,
                          Layer layer)

Check if this exporter can export a certain layer to a certain file. Most exporters support just a single layer type.

Parameters:

pathname - the target file name (check file extension using the filter

layer - the layer requested for export

Returns:

true, if the exporter can handle the layer and filename is okay

exportData

public void exportData(java.io.File file,
                       Layer layer)
                throws java.io.IOException

Execute the data export. (To be overridden by subclasses.)

Parameters:

file - target file

layer - the layer to export

Throws:

java.io.IOException - in case of an IO error

exportDataQuiet

public void exportDataQuiet(java.io.File file,
                            Layer layer)
                     throws java.io.IOException

Execute the data export without prompting the user. (To be overridden by subclasses.)

Parameters:

file - target file

layer - the layer to export

Throws:

java.io.IOException - in case of an IO error

Since:

15496

isEnabled

public final boolean isEnabled()

Returns the enabled state of this FileExporter. When enabled, it is listed and usable in "File → Save" dialogs.

Returns:

true if this FileExporter is enabled

Since:

5459

setEnabled

public final void setEnabled(boolean enabled)

Sets the enabled state of the FileExporter. When enabled, it is listed and usable in "File → Save" dialogs.

Parameters:

enabled - true to enable this FileExporter, false to disable it

Since:

5459

activeOrEditLayerChanged

public void activeOrEditLayerChanged(MainLayerManager.ActiveLayerChangeEvent e)

Description copied from interface: MainLayerManager.ActiveLayerChangeListener

Called whenever the active or edit layer changed.

You can be sure that this layer is still contained in this set.

Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.

Specified by:

activeOrEditLayerChanged in interface MainLayerManager.ActiveLayerChangeListener

Parameters:

e - The change event.

isCanceled

public final boolean isCanceled()

Determines if this exporter has been canceled during export.

Returns:

true if this FileExporter has been canceled

Since:

6815

setCanceled

public final void setCanceled(boolean canceled)

Marks this exporter as canceled.

Parameters:

canceled - true to mark this exporter as canceled, false otherwise

Since:

6815