org.openstreetmap.josm.actions.downloadtasks

Class DownloadGpsTask

java.lang.Object

org.openstreetmap.josm.actions.downloadtasks.AbstractDownloadTask

org.openstreetmap.josm.actions.downloadtasks.DownloadGpsTask

All Implemented Interfaces:

DownloadTask

public class DownloadGpsTask
extends AbstractDownloadTask

Task allowing to download GPS data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	DownloadGpsTask.DownloadTask

Field Summary

Fields

Modifier and Type	Field and Description
private DownloadGpsTask.DownloadTask	downloadTask
protected java.lang.String	newLayerName
private static java.lang.String	PATTERN_EXTERNAL_GPX_FILE
private static java.lang.String	PATTERN_EXTERNAL_GPX_SCRIPT
private static java.lang.String	PATTERN_TRACE_ID
private static java.lang.String	PATTERN_TRACKPOINTS_BBOX

Constructor Summary

Constructors

Constructor and Description
DownloadGpsTask()

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.
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.
java.lang.String[]	getPatterns() Returns regular expressions that match the URLs
java.lang.String	getTitle() Returns human-readable description of the task
static boolean	isFromServer(java.lang.String url) Determines if the given URL denotes an OSM gpx-related API call.
boolean	isSafeForRemotecontrolRequests() Check / decide if the task is safe for remotecontrol.
java.util.concurrent.Future<?>	loadUrl(boolean newLayer, java.lang.String url, ProgressMonitor progressMonitor) Asynchronously launches the download task for a given bounding URL.

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

downloadTask

private DownloadGpsTask.DownloadTask downloadTask

PATTERN_TRACE_ID

private static final java.lang.String PATTERN_TRACE_ID

See Also:

Constant Field Values

PATTERN_TRACKPOINTS_BBOX

private static final java.lang.String PATTERN_TRACKPOINTS_BBOX

See Also:

Constant Field Values

PATTERN_EXTERNAL_GPX_SCRIPT

private static final java.lang.String PATTERN_EXTERNAL_GPX_SCRIPT

See Also:

Constant Field Values

PATTERN_EXTERNAL_GPX_FILE

private static final java.lang.String PATTERN_EXTERNAL_GPX_FILE

See Also:

Constant Field Values

newLayerName

protected java.lang.String newLayerName

Constructor Detail

DownloadGpsTask

public DownloadGpsTask()

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

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

loadUrl

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

Description copied from interface: DownloadTask

Asynchronously launches the download task for a given bounding URL. 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.

Parameters:

newLayer - 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.

url - the url to download from

progressMonitor - the progressMonitor

Returns:

the future representing the asynchronous task

See Also:

DownloadTask.download(boolean, Bounds, ProgressMonitor)

cancel

public void cancel()

Description copied from interface: DownloadTask

Cancels the asynchronous download task.

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

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

isFromServer

public static final boolean isFromServer(java.lang.String url)

Determines if the given URL denotes an OSM gpx-related API call.

Parameters:

url - The url to check

Returns:

true if the url matches "Trace ID" API call or "Trackpoints bbox" API call, false otherwise

Since:

5745

See Also:

GpxData.fromServer