org.openstreetmap.josm.actions.downloadtasks

Class DownloadReferrersTask

java.lang.Object

org.openstreetmap.josm.gui.PleaseWaitRunnable

org.openstreetmap.josm.actions.downloadtasks.DownloadReferrersTask

All Implemented Interfaces:

Runnable, ProgressMonitor.CancelListener

public class DownloadReferrersTask
extends PleaseWaitRunnable

The asynchronous task for downloading referring primitives

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	canceled
private Map<Long,OsmPrimitiveType>	children the collection of child primitives
private Exception	lastException
private DataSet	parents the parents
private OsmServerReader	reader
private OsmDataLayer	targetLayer the target layer

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

progressMonitor

Constructor Summary

Constructors

Constructor and Description
DownloadReferrersTask(OsmDataLayer targetLayer, Collection<OsmPrimitive> children) constructor
DownloadReferrersTask(OsmDataLayer targetLayer, long id, OsmPrimitiveType type) constructor
DownloadReferrersTask(OsmDataLayer targetLayer, Map<Long,OsmPrimitiveType> children) constructor
DownloadReferrersTask(OsmDataLayer targetLayer, PrimitiveId primitiveId) constructor

Method Summary

Modifier and Type	Method and Description
protected void	cancel() User pressed cancel button.
protected void	downloadParents(long id, OsmPrimitiveType type, ProgressMonitor progressMonitor)
protected void	finish() Finish up the data work.
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

Field Detail

canceled

private boolean canceled

lastException

private Exception lastException

reader

private OsmServerReader reader

targetLayer

private OsmDataLayer targetLayer

the target layer

children

private Map<Long,OsmPrimitiveType> children

the collection of child primitives

parents

private DataSet parents

the parents

Constructor Detail

DownloadReferrersTask

public DownloadReferrersTask(OsmDataLayer targetLayer,
                             Collection<OsmPrimitive> children)

constructor

Parameters:

targetLayer - the target layer for the downloaded primitives. Must not be null.

children - the collection of child primitives for which parents are to be downloaded

DownloadReferrersTask

public DownloadReferrersTask(OsmDataLayer targetLayer,
                             Map<Long,OsmPrimitiveType> children)

constructor

Parameters:

targetLayer - the target layer for the downloaded primitives. Must not be null.

children - the collection of children for which parents are to be downloaded. Children are specified by their id and their type.

DownloadReferrersTask

public DownloadReferrersTask(OsmDataLayer targetLayer,
                             long id,
                             OsmPrimitiveType type)
                      throws IllegalArgumentException

constructor

Parameters:

targetLayer - the target layer. Must not be null.

id - the primitive id. id > 0 required.

type - the primitive type. type != null required

Throws:

IllegalArgumentException - thrown if id <= 0

IllegalArgumentException - thrown if type == null

IllegalArgumentException - thrown if targetLayer == null

DownloadReferrersTask

public DownloadReferrersTask(OsmDataLayer targetLayer,
                             PrimitiveId primitiveId)
                      throws IllegalArgumentException

constructor

Parameters:

targetLayer - the target layer. Must not be null.

primitiveId - a PrimitiveId object.

Throws:

IllegalArgumentException - thrown if id <= 0

IllegalArgumentException - thrown if targetLayer == null

Method Detail

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

downloadParents

protected void downloadParents(long id,
                               OsmPrimitiveType type,
                               ProgressMonitor progressMonitor)
                        throws OsmTransferException

Throws:

OsmTransferException

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

IOException

OsmTransferException