org.openstreetmap.josm.io

Class OsmServerWriter

java.lang.Object

org.openstreetmap.josm.io.OsmServerWriter

public class OsmServerWriter
extends java.lang.Object

Class that uploads all changes to the osm server. This is done like this: - All objects with id = 0 are uploaded as new, except those in deleted, which are ignored - All objects in deleted list are deleted. - All remaining objects with modified flag set are updated.

Field Summary

Fields

Modifier and Type	Field and Description
private OsmApi	api
private boolean	canceled
private static java.util.List<OsmServerWritePostprocessor>	postprocessors
private java.util.Collection<OsmPrimitive>	processed This list contains all successfully processed objects.
private long	uploadStartTime

Constructor Summary

Constructors

Constructor and Description
OsmServerWriter()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel operation.
void	executePostprocessors(ProgressMonitor pm) Calls all registered upload postprocessors.
java.util.Collection<OsmPrimitive>	getProcessedPrimitives() Replies the collection of successfully processed primitives
(package private) void	makeApiRequest(OsmPrimitive osm, ProgressMonitor progressMonitor)
static void	registerPostprocessor(OsmServerWritePostprocessor pp) Registers a post-processor.
protected java.lang.String	timeLeft(int progress, int listSize)
static void	unregisterPostprocessor(OsmServerWritePostprocessor pp) Unregisters a post-processor.
protected void	uploadChangesAsDiffUpload(java.util.Collection<? extends OsmPrimitive> primitives, ProgressMonitor progressMonitor) Upload all changes in one diff upload
protected void	uploadChangesInChunks(java.util.Collection<? extends OsmPrimitive> primitives, ProgressMonitor progressMonitor, int chunkSize) Upload all changes in one diff upload
protected void	uploadChangesIndividually(java.util.Collection<? extends OsmPrimitive> primitives, ProgressMonitor progressMonitor) Uploads the changes individually.
void	uploadOsm(UploadStrategySpecification strategy, java.util.Collection<? extends OsmPrimitive> primitives, Changeset changeset, ProgressMonitor monitor) Send the dataset to the server.

Methods inherited from class java.lang.Object

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

Field Detail

processed

private java.util.Collection<OsmPrimitive> processed

This list contains all successfully processed objects. The caller of upload* has to check this after the call and update its dataset. If a server connection error occurs, this may contain fewer entries than where passed in the list to upload*.

postprocessors

private static volatile java.util.List<OsmServerWritePostprocessor> postprocessors

api

private final OsmApi api

canceled

private boolean canceled

uploadStartTime

private long uploadStartTime

Constructor Detail

OsmServerWriter

public OsmServerWriter()

Method Detail

registerPostprocessor

public static void registerPostprocessor(OsmServerWritePostprocessor pp)

Registers a post-processor.

Parameters:

pp - post-processor to register

unregisterPostprocessor

public static void unregisterPostprocessor(OsmServerWritePostprocessor pp)

Unregisters a post-processor.

Parameters:

pp - post-processor to unregister

timeLeft

protected java.lang.String timeLeft(int progress,
                                    int listSize)

uploadChangesIndividually

protected void uploadChangesIndividually(java.util.Collection<? extends OsmPrimitive> primitives,
                                         ProgressMonitor progressMonitor)
                                  throws OsmTransferException

Uploads the changes individually. Invokes one API call per uploaded primitive.

Parameters:

primitives - the collection of primitives to upload

progressMonitor - the progress monitor

Throws:

OsmTransferException - if an exception occurs

uploadChangesAsDiffUpload

protected void uploadChangesAsDiffUpload(java.util.Collection<? extends OsmPrimitive> primitives,
                                         ProgressMonitor progressMonitor)
                                  throws OsmTransferException

Upload all changes in one diff upload

Parameters:

primitives - the collection of primitives to upload

progressMonitor - the progress monitor

Throws:

OsmTransferException - if an exception occurs

uploadChangesInChunks

protected void uploadChangesInChunks(java.util.Collection<? extends OsmPrimitive> primitives,
                                     ProgressMonitor progressMonitor,
                                     int chunkSize)
                              throws OsmTransferException

Upload all changes in one diff upload

Parameters:

primitives - the collection of primitives to upload

progressMonitor - the progress monitor

chunkSize - the size of the individual upload chunks. > 0 required.

Throws:

java.lang.IllegalArgumentException - if chunkSize <= 0

OsmTransferException - if an exception occurs

uploadOsm

public void uploadOsm(UploadStrategySpecification strategy,
                      java.util.Collection<? extends OsmPrimitive> primitives,
                      Changeset changeset,
                      ProgressMonitor monitor)
               throws OsmTransferException

Send the dataset to the server.

Parameters:

strategy - the upload strategy. Must not be null.

primitives - list of objects to send

changeset - the changeset the data is uploaded to. Must not be null.

monitor - the progress monitor. If null, assumes NullProgressMonitor.INSTANCE

Throws:

java.lang.IllegalArgumentException - if changeset is null

java.lang.IllegalArgumentException - if strategy is null

OsmTransferException - if something goes wrong

makeApiRequest

void makeApiRequest(OsmPrimitive osm,
                    ProgressMonitor progressMonitor)
             throws OsmTransferException

Throws:

OsmTransferException

cancel

public void cancel()

Cancel operation.

getProcessedPrimitives

public java.util.Collection<OsmPrimitive> getProcessedPrimitives()

Replies the collection of successfully processed primitives

Returns:

the collection of successfully processed primitives

executePostprocessors

public void executePostprocessors(ProgressMonitor pm)

Calls all registered upload postprocessors.

Parameters:

pm - progress monitor