org.openstreetmap.josm.io.session

Interface SessionLayerExporter

All Known Implementing Classes:

AbstractSessionExporter, GenericSessionExporter, GeoImageSessionExporter, GpxTracksSessionExporter, ImagerySessionExporter, MarkerSessionExporter, NoteSessionExporter, OsmDataSessionExporter

public interface SessionLayerExporter

Session layer exporter.

Since:

4685

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Element	export(SessionWriter.ExportSupport support) Save meta data to the .jos file.
java.util.Collection<Layer>	getDependencies() Return the Layers, this Layer depends on.
java.awt.Component	getExportPanel() The GUI for exporting this layer.
boolean	requiresZip() Return true, if some data needs to be included in the zip archive.
boolean	shallExport() Return true, if the layer should be included in the list of exported layers.

Method Detail

getDependencies

java.util.Collection<Layer> getDependencies()

Return the Layers, this Layer depends on.

Returns:

the layer dependencies

getExportPanel

java.awt.Component getExportPanel()

The GUI for exporting this layer.

Returns:

the export panel

shallExport

boolean shallExport()

Return true, if the layer should be included in the list of exported layers. The user can veto this in the export panel.

Returns:

true if the layer should be included in the list of exported layers, false otherwise.

requiresZip

boolean requiresZip()

Return true, if some data needs to be included in the zip archive. This decision depends on the user selection in the export panel. If any layer requires zip, the user can only save as .joz. Otherwise both .jos and .joz are possible.

Returns:

true if some data needs to be included in the zip archive, false otherwise.

export

org.w3c.dom.Element export(SessionWriter.ExportSupport support)
                    throws java.io.IOException

Save meta data to the .jos file. Return a layer XML element. Use support to save files in the zip archive as needed.

Parameters:

support - support class providing export utilities

Returns:

the resulting XML element

Throws:

java.io.IOException - if any I/O error occurs