org.openstreetmap.josm.actions.downloadtasks

Class DownloadOsmTask

java.lang.Object

org.openstreetmap.josm.actions.downloadtasks.AbstractDownloadTask

org.openstreetmap.josm.actions.downloadtasks.DownloadOsmTask

All Implemented Interfaces:

DownloadTask

Direct Known Subclasses:

DownloadOsmChangeTask, DownloadOsmCompressedTask, DownloadOsmUrlTask

public class DownloadOsmTask
extends AbstractDownloadTask

Open the download dialog and download the data. Run in the worker thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DownloadOsmTask.AbstractInternalTask Superclass of internal download task.
protected class	DownloadOsmTask.DownloadTask

Field Summary

Fields

Modifier and Type	Field and Description
protected Bounds	currentBounds
protected DataSet	downloadedData
protected DownloadOsmTask.DownloadTask	downloadTask
protected java.lang.String	newLayerName
protected static java.lang.String	PATTERN_EXTERNAL_OSM_FILE
protected static java.lang.String	PATTERN_OSM_API_URL
protected static java.lang.String	PATTERN_OVERPASS_API_URL
protected static java.lang.String	PATTERN_OVERPASS_API_XAPI_URL

Constructor Summary

Constructors

Constructor and Description
DownloadOsmTask()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the asynchronous download task.
java.util.concurrent.Future<?>	download(boolean newLayer, Bounds downloadArea, ProgressMonitor progressMonitor) Asynchronously launches the download task for a given bounding box.
protected java.util.concurrent.Future<?>	download(DownloadOsmTask.DownloadTask downloadTask, Bounds downloadArea)
java.util.concurrent.Future<?>	download(OsmServerReader reader, boolean newLayer, Bounds downloadArea, ProgressMonitor progressMonitor) Asynchronously launches the download task for a given bounding box.
protected void	extractOsmFilename(java.lang.String pattern, java.lang.String url)
java.lang.String	getConfirmationMessage(java.net.URL url) Replies the HTML-formatted confirmation message to be shown to user when the given URL needs to be confirmed before loading.
DataSet	getDownloadedData() Replies the DataSet containing the downloaded OSM data.
java.lang.String[]	getPatterns() Returns regular expressions that match the URLs
java.lang.String	getTitle() Returns human-readable description of the task
boolean	isSafeForRemotecontrolRequests() Check / decide if the task is safe for remotecontrol.
java.util.concurrent.Future<?>	loadUrl(boolean new_layer, java.lang.String url, ProgressMonitor progressMonitor) Loads a given URL from the OSM Server
protected java.lang.String	modifyUrlBeforeLoad(java.lang.String url) This allows subclasses to perform operations on the URL before loadUrl(boolean, java.lang.String, org.openstreetmap.josm.gui.progress.ProgressMonitor) is performed.
protected void	rememberDownloadedData(DataSet ds)

Methods inherited from class org.openstreetmap.josm.actions.downloadtasks.AbstractDownloadTask

acceptsDocumentationSummary, acceptsUrl, acceptsUrl, getErrorObjects, isCanceled, isFailed, rememberErrorMessage, rememberException, setCanceled, setFailed

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN_OSM_API_URL

protected static final java.lang.String PATTERN_OSM_API_URL

See Also:

Constant Field Values

PATTERN_OVERPASS_API_URL

protected static final java.lang.String PATTERN_OVERPASS_API_URL

See Also:

Constant Field Values

PATTERN_OVERPASS_API_XAPI_URL

protected static final java.lang.String PATTERN_OVERPASS_API_XAPI_URL

See Also:

Constant Field Values

PATTERN_EXTERNAL_OSM_FILE

protected static final java.lang.String PATTERN_EXTERNAL_OSM_FILE

See Also:

Constant Field Values

currentBounds

protected Bounds currentBounds

downloadedData

protected DataSet downloadedData

downloadTask

protected DownloadOsmTask.DownloadTask downloadTask

newLayerName

protected java.lang.String newLayerName

Constructor Detail

DownloadOsmTask

public DownloadOsmTask()

Method Detail

getPatterns

public java.lang.String[] getPatterns()

Description copied from interface: DownloadTask

Returns regular expressions that match the URLs

Specified by:

getPatterns in interface DownloadTask

Overrides:

getPatterns in class AbstractDownloadTask

Returns:

The array of accepted URL patterns

getTitle

public java.lang.String getTitle()

Description copied from interface: DownloadTask

Returns human-readable description of the task

Specified by:

getTitle in interface DownloadTask

Overrides:

getTitle in class AbstractDownloadTask

Returns:

The task description

rememberDownloadedData

protected void rememberDownloadedData(DataSet ds)

getDownloadedData

public DataSet getDownloadedData()

Replies the DataSet containing the downloaded OSM data.

Returns:

The DataSet containing the downloaded OSM data.

download

public java.util.concurrent.Future<?> download(boolean newLayer,
                                               Bounds downloadArea,
                                               ProgressMonitor progressMonitor)

Description copied from interface: DownloadTask

Asynchronously launches the download task for a given bounding box. Set progressMonitor to null, if the task should create, open, and close a progress monitor. Set progressMonitor to NullProgressMonitor.INSTANCE if progress information is to be discarded. You can wait for the asynchronous download task to finish by synchronizing on the returned Future, but make sure not to freeze up JOSM. Example:

    Future<?> future = task.download(...);
    // DON'T run this on the Swing EDT or JOSM will freeze
    future.get(); // waits for the dowload task to complete
 

The following example uses a pattern which is better suited if a task is launched from the Swing EDT:

    final Future<?> future = task.download(...);
    Runnable runAfterTask = new Runnable() {
       public void run() {
           // this is not strictly necessary because of the type of executor service
           // Main.worker is initialized with, but it doesn't harm either
           //
           future.get(); // wait for the download task to complete
           doSomethingAfterTheTaskCompleted();
       }
    }
    Main.worker.submit(runAfterTask);
 

Parameters:

newLayer - true, if the data is to be downloaded into a new layer. If false, the task selects one of the existing layers as download layer, preferably the active layer.

downloadArea - the area to download

progressMonitor - the progressMonitor

Returns:

the future representing the asynchronous task

download

public java.util.concurrent.Future<?> download(OsmServerReader reader,
                                               boolean newLayer,
                                               Bounds downloadArea,
                                               ProgressMonitor progressMonitor)

Asynchronously launches the download task for a given bounding box. Set progressMonitor to null, if the task should create, open, and close a progress monitor. Set progressMonitor to NullProgressMonitor.INSTANCE if progress information is to be discarded. You can wait for the asynchronous download task to finish by synchronizing on the returned Future, but make sure not to freeze up JOSM. Example:

    Future<?> future = task.download(...);
    // DON'T run this on the Swing EDT or JOSM will freeze
    future.get(); // waits for the dowload task to complete
 

The following example uses a pattern which is better suited if a task is launched from the Swing EDT:

    final Future<?> future = task.download(...);
    Runnable runAfterTask = new Runnable() {
       public void run() {
           // this is not strictly necessary because of the type of executor service
           // Main.worker is initialized with, but it doesn't harm either
           //
           future.get(); // wait for the download task to complete
           doSomethingAfterTheTaskCompleted();
       }
    }
    Main.worker.submit(runAfterTask);
 

Parameters:

reader - the reader used to parse OSM data (see OsmServerReader.parseOsm(org.openstreetmap.josm.gui.progress.ProgressMonitor))

newLayer - true, if the data is to be downloaded into a new layer. If false, the task selects one of the existing layers as download layer, preferably the active layer.

downloadArea - the area to download

progressMonitor - the progressMonitor

Returns:

the future representing the asynchronous task

download

protected java.util.concurrent.Future<?> download(DownloadOsmTask.DownloadTask downloadTask,
                                                  Bounds downloadArea)

modifyUrlBeforeLoad

protected java.lang.String modifyUrlBeforeLoad(java.lang.String url)

This allows subclasses to perform operations on the URL before loadUrl(boolean, java.lang.String, org.openstreetmap.josm.gui.progress.ProgressMonitor) is performed.

loadUrl

public java.util.concurrent.Future<?> loadUrl(boolean new_layer,
                                              java.lang.String url,
                                              ProgressMonitor progressMonitor)

Loads a given URL from the OSM Server

Parameters:

new_layer - True if the data should be saved to a new layer

url - The URL as String

progressMonitor - the progressMonitor

Returns:

the future representing the asynchronous task

See Also:

DownloadTask.download(boolean, Bounds, ProgressMonitor)

extractOsmFilename

protected final void extractOsmFilename(java.lang.String pattern,
                                        java.lang.String url)

cancel

public void cancel()

Description copied from interface: DownloadTask

Cancels the asynchronous download task.

isSafeForRemotecontrolRequests

public boolean isSafeForRemotecontrolRequests()

Description copied from class: AbstractDownloadTask

Check / decide if the task is safe for remotecontrol. Keep in mind that a potential attacker has full control over the content of the file that will be downloaded. If it is possible to run arbitrary code or write to the local file system, then the task is (obviously) not save for remote execution. The default value is false = unsafe. Override in a subclass to allow running the task via remotecontol.

Overrides:

isSafeForRemotecontrolRequests in class AbstractDownloadTask

Returns:

true if it is safe to download and open any file of the corresponding format, false otherwise

getConfirmationMessage

public java.lang.String getConfirmationMessage(java.net.URL url)

Description copied from interface: DownloadTask

Replies the HTML-formatted confirmation message to be shown to user when the given URL needs to be confirmed before loading.

Parameters:

url - The URL to be confirmed

Returns:

The HTML-formatted confirmation message to be shown to user