source: josm/trunk/src/org/openstreetmap/josm/gui/io/UploadLayerTask.java@ 2181

// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.io;

import static org.openstreetmap.josm.tools.I18n.tr;

import java.util.Collection;

import org.openstreetmap.josm.data.APIDataSet;
import org.openstreetmap.josm.data.osm.Changeset;
import org.openstreetmap.josm.data.osm.DataSet;
import org.openstreetmap.josm.data.osm.OsmPrimitive;
import org.openstreetmap.josm.gui.layer.OsmDataLayer;
import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
import org.openstreetmap.josm.gui.progress.ProgressMonitor;
import org.openstreetmap.josm.io.ChangesetProcessingType;
import org.openstreetmap.josm.io.OsmServerWriter;

/**
 * UploadLayerTask uploads the data managed by an {@see OsmDataLayer} asynchronously.
 * 
 * <pre>
 *     ExecutorService executorService = ...
 *     UploadLayerTask task = new UploadLayerTask(layer, monitor);
 *     Future<?> taskFuture = executorServce.submit(task)
 *     try {
 *        // wait for the task to complete
 *        taskFuture.get();
 *     } catch(Exception e) {
 *        e.printStackTracek();
 *     }
 * </pre>
 */
class UploadLayerTask extends AbstractIOTask implements Runnable {
    private OsmServerWriter writer;
    private OsmDataLayer layer;
    private ProgressMonitor monitor;
    private Changeset changeset;
    private boolean closeChangesetAfterUpload;

    /**
     * 
     * @param layer the layer. Must not be null.
     * @param monitor  a progress monitor. If monitor is null, uses {@see NullProgressMonitor#INSTANCE}
     * @param changeset the changeset to be used if <code>changesetProcessingType</code> indicates that a new
     *   changeset is to be used
     * @param closeChangesetAfterUpload true, if the changeset should be closed after the upload
     * @throws IllegalArgumentException thrown, if layer is null
     */
    public UploadLayerTask(OsmDataLayer layer, ProgressMonitor monitor, Changeset changeset, boolean closeChangesetAfterUpload) {
        if (layer == null)
            throw new IllegalArgumentException(tr("Parameter ''{0}'' must not be null.", layer));
        if (monitor == null) {
            monitor = NullProgressMonitor.INSTANCE;
        }
        this.layer = layer;
        this.monitor = monitor;
        this.changeset = changeset;
        this.closeChangesetAfterUpload = closeChangesetAfterUpload;
    }

    @Override
    public void run() {
        monitor.subTask(tr("Preparing primitives to upload ..."));
        Collection<OsmPrimitive> toUpload = new APIDataSet(layer.data).getPrimitives();
        if (toUpload.isEmpty())
            return;
        writer = new OsmServerWriter();
        try {
            ProgressMonitor m = monitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false);
            if (isCancelled()) return;
            writer.uploadOsm(layer.data.version, toUpload, changeset, closeChangesetAfterUpload, m);
        } catch (Exception sxe) {
            if (isCancelled()) {
                System.out.println("Ignoring exception caught because upload is cancelled. Exception is: " + sxe.toString());
                return;
            }
            setLastException(sxe);
        }

        if (isCancelled())
            return;
        layer.cleanupAfterUpload(writer.getProcessedPrimitives());
        DataSet.fireSelectionChanged(layer.data.getSelected());
        layer.fireDataChange();
        layer.onPostUploadToServer();
    }

    @Override
    public void cancel() {
        // make sure the the softCancel operation is serialized with
        // blocks which can be interrupted.
        setCancelled(true);
        if (writer != null) {
            writer.cancel();
        }
    }
}