org.openstreetmap.josm.gui.dialogs.changeset

Class ChangesetHeaderDownloadTask

java.lang.Object

org.openstreetmap.josm.gui.PleaseWaitRunnable

org.openstreetmap.josm.gui.dialogs.changeset.ChangesetHeaderDownloadTask

All Implemented Interfaces:

Runnable, ChangesetDownloadTask, ProgressMonitor.CancelListener

public class ChangesetHeaderDownloadTask
extends PleaseWaitRunnable
implements ChangesetDownloadTask

This is an asynchronous task for downloading a collection of changests from the OSM server. The task only downloads the changeset properties without the changeset content. It updates the global ChangesetCache.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	canceled
private Set<Changeset>	downloadedChangesets
private Set<Integer>	idsToDownload
private boolean	includeDiscussion
private Exception	lastException
private OsmServerChangesetReader	reader

Fields inherited from class org.openstreetmap.josm.gui.PleaseWaitRunnable

progressMonitor

Constructor Summary

Constructors

Constructor and Description
ChangesetHeaderDownloadTask(Collection<Integer> ids) Creates the download task for a collection of changeset ids.
ChangesetHeaderDownloadTask(Component dialogParent, Collection<Integer> ids) Creates the download task for a collection of changeset ids.
ChangesetHeaderDownloadTask(Component dialogParent, Collection<Integer> ids, boolean includeDiscussion) Creates the download task for a collection of changeset ids, with possibility to download changeset discussion.

Method Summary

Modifier and Type	Method and Description
static ChangesetHeaderDownloadTask	buildTaskForChangesets(Collection<Changeset> changesets) Builds a download task from for a collection of changesets.
static ChangesetHeaderDownloadTask	buildTaskForChangesets(Component parent, Collection<Changeset> changesets) Builds a download task from for a collection of changesets.
protected void	cancel() User pressed cancel button.
protected void	finish() Finish up the data work.
Set<Changeset>	getDownloadedChangesets()
protected void	init(Collection<Integer> ids)
boolean	isCanceled()
boolean	isFailed()
protected void	realRun() Called in the worker thread to do the actual work.

Methods inherited from class org.openstreetmap.josm.gui.PleaseWaitRunnable

afterFinish, canRunInBackground, getProgressMonitor, operationCanceled, run

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

idsToDownload

private Set<Integer> idsToDownload

reader

private OsmServerChangesetReader reader

canceled

private boolean canceled

lastException

private Exception lastException

downloadedChangesets

private Set<Changeset> downloadedChangesets

includeDiscussion

private final boolean includeDiscussion

Constructor Detail

ChangesetHeaderDownloadTask

public ChangesetHeaderDownloadTask(Collection<Integer> ids)

Creates the download task for a collection of changeset ids. Uses a PleaseWaitDialog whose parent is Main.parent. Null ids or or ids <= 0 in the id collection are ignored.

Parameters:

ids - the collection of ids. Empty collection assumed if null.

ChangesetHeaderDownloadTask

public ChangesetHeaderDownloadTask(Component dialogParent,
                                   Collection<Integer> ids)

Creates the download task for a collection of changeset ids. Uses a PleaseWaitDialog whose parent is the parent window of dialogParent. Null ids or or ids <= 0 in the id collection are ignored.

Parameters:

dialogParent - the parent reference component for the PleaseWaitDialog. Must not be null.

ids - the collection of ids. Empty collection assumed if null.

Throws:

IllegalArgumentException - if dialogParent is null

ChangesetHeaderDownloadTask

public ChangesetHeaderDownloadTask(Component dialogParent,
                                   Collection<Integer> ids,
                                   boolean includeDiscussion)

Creates the download task for a collection of changeset ids, with possibility to download changeset discussion. Uses a PleaseWaitDialog whose parent is the parent window of dialogParent. Null ids or or ids <= 0 in the id collection are ignored.

Parameters:

dialogParent - the parent reference component for the PleaseWaitDialog. Must not be null.

ids - the collection of ids. Empty collection assumed if null.

includeDiscussion - determines if discussion comments must be downloaded or not

Throws:

IllegalArgumentException - if dialogParent is null

Since:

7704

Method Detail

buildTaskForChangesets

public static ChangesetHeaderDownloadTask buildTaskForChangesets(Collection<Changeset> changesets)

Builds a download task from for a collection of changesets. Ignores null values and changesets with Changeset.isNew() == true.

Parameters:

changesets - the collection of changesets. Assumes an empty collection if null.

Returns:

the download task

buildTaskForChangesets

public static ChangesetHeaderDownloadTask buildTaskForChangesets(Component parent,
                                                                 Collection<Changeset> changesets)

Builds a download task from for a collection of changesets. Ignores null values and changesets with Changeset.isNew() == true.

Parameters:

parent - the parent component relative to which the PleaseWaitDialog is displayed. Must not be null.

changesets - the collection of changesets. Assumes an empty collection if null.

Returns:

the download task

Throws:

IllegalArgumentException - if parent is null

init

protected void init(Collection<Integer> ids)

cancel

protected void cancel()

Description copied from class: PleaseWaitRunnable

User pressed cancel button.

Specified by:

cancel in class PleaseWaitRunnable

finish

protected void finish()

Description copied from class: PleaseWaitRunnable

Finish up the data work. Is guaranteed to be called if realRun is called. Finish is called in the gui thread just after the dialog disappeared.

Specified by:

finish in class PleaseWaitRunnable

realRun

protected void realRun()
                throws SAXException,
                       IOException,
                       OsmTransferException

Description copied from class: PleaseWaitRunnable

Called in the worker thread to do the actual work. When any of the exception is thrown, a message box will be displayed and closeDialog is called. finish() is called in any case.

Specified by:

realRun in class PleaseWaitRunnable

Throws:

SAXException - if a SAX error occurs

IOException - if an I/O error occurs

OsmTransferException - if a communication error with the OSM server occurs

getDownloadedChangesets

public Set<Changeset> getDownloadedChangesets()

Specified by:

getDownloadedChangesets in interface ChangesetDownloadTask

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface ChangesetDownloadTask

isFailed

public boolean isFailed()

Specified by:

isFailed in interface ChangesetDownloadTask