001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.io.session;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005
006import java.io.IOException;
007import java.io.OutputStream;
008import java.io.OutputStreamWriter;
009import java.io.PrintWriter;
010import java.io.Writer;
011import java.nio.charset.StandardCharsets;
012import java.time.Instant;
013
014import javax.swing.JCheckBox;
015import javax.swing.JPanel;
016
017import org.openstreetmap.josm.gui.layer.GpxLayer;
018import org.openstreetmap.josm.io.GpxWriter;
019import org.openstreetmap.josm.io.session.SessionWriter.ExportSupport;
020import org.openstreetmap.josm.tools.GBC;
021import org.w3c.dom.Element;
022
023/**
024 * Session exporter for {@link GpxLayer}.
025 * @since 5501
026 */
027public class GpxTracksSessionExporter extends GenericSessionExporter<GpxLayer> {
028
029    private Instant metaTime;
030    private JCheckBox chkMarkers;
031    private boolean hasMarkerLayer;
032
033    /**
034     * Constructs a new {@code GpxTracksSessionExporter}.
035     * @param layer GPX layer to export
036     */
037    public GpxTracksSessionExporter(GpxLayer layer) { // NO_UCD (test only)
038        this(layer, "tracks");
039    }
040
041    protected GpxTracksSessionExporter(GpxLayer layer, String type) {
042        super(layer, type, "0.1", "gpx");
043        if (layer.data == null) {
044            throw new IllegalArgumentException("GPX layer without data: " + layer);
045        }
046
047        hasMarkerLayer = layer.getLinkedMarkerLayer() != null
048                && layer.getLinkedMarkerLayer().data != null
049                && !layer.getLinkedMarkerLayer().data.isEmpty();
050    }
051
052    @Override
053    public JPanel getExportPanel() {
054        JPanel p = super.getExportPanel();
055        if (hasMarkerLayer) {
056            chkMarkers = new JCheckBox();
057            chkMarkers.setText(tr("include marker layer \"{0}\"", layer.getLinkedMarkerLayer().getName()));
058            chkMarkers.setSelected(true);
059            p.add(chkMarkers, GBC.eol().insets(12, 0, 0, 5));
060        }
061        return p;
062    }
063
064    @Override
065    public Element export(ExportSupport support) throws IOException {
066        Element el = super.export(support);
067        if (hasMarkerLayer && (chkMarkers == null || chkMarkers.isSelected())) {
068            Element markerEl = support.createElement("markerLayer");
069            markerEl.setAttribute("index", Integer.toString(support.getLayerIndexOf(layer.getLinkedMarkerLayer())));
070            markerEl.setAttribute("name", layer.getLinkedMarkerLayer().getName());
071            markerEl.setAttribute("visible", Boolean.toString(layer.getLinkedMarkerLayer().isVisible()));
072            if (layer.getLinkedMarkerLayer().getOpacity() != 1) {
073                markerEl.setAttribute("opacity", Double.toString(layer.getLinkedMarkerLayer().getOpacity()));
074            }
075            el.appendChild(markerEl);
076        }
077        return el;
078    }
079
080    @Override
081    // The new closable resources in this method will close the input OutputStream
082    @SuppressWarnings("squid:S2095")
083    protected void addDataFile(OutputStream out) {
084        Writer writer = new OutputStreamWriter(out, StandardCharsets.UTF_8);
085        GpxWriter w = new GpxWriter(new PrintWriter(writer));
086        if (metaTime != null) {
087            w.setMetaTime(metaTime);
088        }
089        w.write(layer.data);
090        w.flush();
091    }
092
093    protected void setMetaTime(Instant metaTime) {
094        this.metaTime = metaTime;
095    }
096}