hu.supercluster.overpasser.library.query

Class OverpassQuery

java.lang.Object

hu.supercluster.overpasser.library.query.OverpassQuery

public class OverpassQuery
extends java.lang.Object

The main query class to create and build requests using the Overpass QL

Field Summary

Fields

Modifier and Type	Field and Description
protected hu.supercluster.overpasser.library.query.OverpassQueryBuilder	builder

Constructor Summary

Constructors

Constructor and Description
OverpassQuery()

Method Summary

Modifier and Type	Method and Description
OverpassQuery	boundingBox(double southernLat, double westernLon, double northernLat, double easternLon) Defines a global bounding box that is then implicitly added to all queries (unless they specify a different explicit bounding box)
java.lang.String	build() Closes the current query with the character ; and returns the output as a string.
OverpassFilterQuery	filterQuery() Creates a map query to embed its output in the current query.
OverpassQuery	format(OutputFormat outputFormat) Controls the output format used to return OSM data.
void	onSubQueryResult(hu.supercluster.overpasser.library.query.AbstractOverpassSubQuery subQuery)
OverpassQuery	output(int limit) Appends the print (out) action to the query with default parameters: verbosity: OutputVerbosity.BODY modificator: OutputModificator.CENTER order: OutputOrder.QT
OverpassQuery	output(OutputVerbosity verbosity, OutputModificator modificator, OutputOrder order, int limit) Appends a ; character and the print (out) action to the query.
OverpassQuery	timeout(int timeout) Sets the maximum allowed runtime for the query in seconds.

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected hu.supercluster.overpasser.library.query.OverpassQueryBuilder builder

Constructor Detail

OverpassQuery

public OverpassQuery()

Method Detail

format

public OverpassQuery format(OutputFormat outputFormat)

Controls the output format used to return OSM data.

Parameters:

outputFormat - the OutputFormat to use

Returns:

the current OverpassQuery object

See Also:

http://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL#Output_Format_.28out.29

timeout

public OverpassQuery timeout(int timeout)

Sets the maximum allowed runtime for the query in seconds.

Parameters:

timeout - the maximum allowed runtime in seconds

Returns:

the current OverpassQuery object

See Also:

http://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL#timeout

boundingBox

public OverpassQuery boundingBox(double southernLat,
                                 double westernLon,
                                 double northernLat,
                                 double easternLon)

Defines a global bounding box that is then implicitly added to all queries (unless they specify a different explicit bounding box)

Parameters:

southernLat - the southern latitude

westernLon - the western longitude

northernLat - the northern latitude

easternLon - the eastern longitude

Returns:

the current OverpassQuery object

filterQuery

public OverpassFilterQuery filterQuery()

Creates a map query to embed its output in the current query.

Returns:

the map query

output

public OverpassQuery output(int limit)

Appends the print (out) action to the query with default parameters:

• verbosity: OutputVerbosity.BODY
• modificator: OutputModificator.CENTER
• order: OutputOrder.QT

Parameters:

limit - maximum number of elements to return

Returns:

the current OverpassQuery object

See Also:

output(OutputVerbosity, OutputModificator, OutputOrder, int)

output

public OverpassQuery output(OutputVerbosity verbosity,
                            OutputModificator modificator,
                            OutputOrder order,
                            int limit)

Appends a ; character and the print (out) action to the query.

Parameters:

verbosity - degree of output verbosity (see OutputVerbosity)

modificator - output modificator for derived information (see OutputModificator)

order - sort order (see OutputOrder)

limit - maximum number of elements to return

Returns:

the current OverpassQuery object

See Also:

http://wiki.openstreetmap.org/wiki/Overpass_API/Overpass_QL#Print_.28out.29

build

public java.lang.String build()

Closes the current query with the character ; and returns the output as a string.

Returns:

the query as string

onSubQueryResult

public void onSubQueryResult(hu.supercluster.overpasser.library.query.AbstractOverpassSubQuery subQuery)