org.openstreetmap.josm.io

Class OverpassDownloadReader

java.lang.Object

org.openstreetmap.josm.io.OsmConnection

org.openstreetmap.josm.io.OsmServerReader

org.openstreetmap.josm.io.BoundingBoxDownloader

org.openstreetmap.josm.io.OverpassDownloadReader

public class OverpassDownloadReader
extends BoundingBoxDownloader

Read content from an Overpass server.

Since:

8744

Nested Class Summary

Nested classes/interfaces inherited from class org.openstreetmap.josm.io.BoundingBoxDownloader

BoundingBoxDownloader.MoreNotesException

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	overpassQuery
(package private) java.lang.String	overpassServer

Fields inherited from class org.openstreetmap.josm.io.BoundingBoxDownloader

crosses180th, lat1, lat2, lon1, lon2

Fields inherited from class org.openstreetmap.josm.io.OsmServerReader

gpxParsedProperly

Fields inherited from class org.openstreetmap.josm.io.OsmConnection

activeConnection, cancel, oauthParameters

Constructor Summary

Constructors

Constructor and Description
OverpassDownloadReader(Bounds downloadArea, java.lang.String overpassServer, java.lang.String overpassQuery) Constructs a new OverpassDownloadReader.

Method Summary

Modifier and Type	Method and Description
protected void	adaptRequest(HttpClient request) Allows subclasses to modify the request.
private static java.lang.String	completeOverpassQuery(java.lang.String query)
protected java.lang.String	getBaseUrl() Return the base URL for relative URL requests
protected java.io.InputStream	getInputStreamRaw(java.lang.String urlStr, ProgressMonitor progressMonitor, java.lang.String reason, boolean uncompressAccordingToContentDisposition) Open a connection to the given url and return a reader on the input stream from that connection.
protected java.lang.String	getRequestForBbox(double lon1, double lat1, double lon2, double lat2) Builds the request part for the bounding box.
protected java.lang.String	getTaskName() Returns the name of the download task to be displayed in the ProgressMonitor.
protected DataSet	parseDataSet(java.io.InputStream source, ProgressMonitor progressMonitor) Parse the given input source and return the dataset.
DataSet	parseOsm(ProgressMonitor progressMonitor) Download OSM files from somewhere

Methods inherited from class org.openstreetmap.josm.io.BoundingBoxDownloader

parseNotes, parseRawGps

Methods inherited from class org.openstreetmap.josm.io.OsmServerReader

getInputStream, getInputStream, getInputStreamRaw, getInputStreamRaw, isDoAuthenticate, isGpxParsedProperly, parseOsmBzip2, parseOsmChange, parseOsmChangeBzip2, parseOsmChangeGzip, parseOsmGzip, parseOsmZip, parseRawGpsBzip2, parseRawNotes, parseRawNotesBzip2, setDoAuthenticate

Methods inherited from class org.openstreetmap.josm.io.OsmConnection

addAuth, addBasicAuthorizationHeader, addOAuthAuthorizationHeader, cancel, isCanceled, obtainAccessToken

Methods inherited from class java.lang.Object

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

Field Detail

overpassServer

final java.lang.String overpassServer

overpassQuery

final java.lang.String overpassQuery

Constructor Detail

OverpassDownloadReader

public OverpassDownloadReader(Bounds downloadArea,
                              java.lang.String overpassServer,
                              java.lang.String overpassQuery)

Constructs a new OverpassDownloadReader.

Parameters:

downloadArea - The area to download

overpassServer - The Overpass server to use

overpassQuery - The Overpass query

Method Detail

getBaseUrl

protected java.lang.String getBaseUrl()

Description copied from class: OsmServerReader

Return the base URL for relative URL requests

Overrides:

getBaseUrl in class OsmServerReader

Returns:

base url of API

getRequestForBbox

protected java.lang.String getRequestForBbox(double lon1,
                                             double lat1,
                                             double lon2,
                                             double lat2)

Description copied from class: BoundingBoxDownloader

Builds the request part for the bounding box.

Overrides:

getRequestForBbox in class BoundingBoxDownloader

Parameters:

lon1 - left

lat1 - bottom

lon2 - right

lat2 - top

Returns:

"map?bbox=left,bottom,right,top"

completeOverpassQuery

private static java.lang.String completeOverpassQuery(java.lang.String query)

getInputStreamRaw

protected java.io.InputStream getInputStreamRaw(java.lang.String urlStr,
                                                ProgressMonitor progressMonitor,
                                                java.lang.String reason,
                                                boolean uncompressAccordingToContentDisposition)
                                         throws OsmTransferException

Description copied from class: OsmServerReader

Open a connection to the given url and return a reader on the input stream from that connection. In case of user cancel, return null.

Overrides:

getInputStreamRaw in class OsmServerReader

Parameters:

urlStr - The exact url to connect to.

progressMonitor - progress monitoring and abort handler

reason - The reason to show on console. Can be null if no reason is given

uncompressAccordingToContentDisposition - Whether to inspect the HTTP header Content-Disposition for filename and uncompress a gzip/bzip2 stream.

Returns:

An reader reading the input stream (servers answer) or null.

Throws:

OsmTransferException - if data transfer errors occur

adaptRequest

protected void adaptRequest(HttpClient request)

Description copied from class: OsmServerReader

Allows subclasses to modify the request.

Overrides:

adaptRequest in class OsmServerReader

Parameters:

request - the prepared request

getTaskName

protected java.lang.String getTaskName()

Description copied from class: BoundingBoxDownloader

Returns the name of the download task to be displayed in the ProgressMonitor.

Overrides:

getTaskName in class BoundingBoxDownloader

Returns:

task name

parseDataSet

protected DataSet parseDataSet(java.io.InputStream source,
                               ProgressMonitor progressMonitor)
                        throws IllegalDataException

Description copied from class: BoundingBoxDownloader

Parse the given input source and return the dataset.

Overrides:

parseDataSet in class BoundingBoxDownloader

Parameters:

source - input stream

progressMonitor - progress monitor

Returns:

dataset

Throws:

IllegalDataException - if an error was found while parsing the OSM data

See Also:

OsmReader.parseDataSet(InputStream, ProgressMonitor)

parseOsm

public DataSet parseOsm(ProgressMonitor progressMonitor)
                 throws OsmTransferException

Description copied from class: OsmServerReader

Download OSM files from somewhere

Overrides:

parseOsm in class BoundingBoxDownloader

Parameters:

progressMonitor - The progress monitor

Returns:

The corresponding dataset

Throws:

OsmTransferException - if any error occurs