hu.supercluster.overpasser.library.query

Class OverpassFilterQuery

java.lang.Object

hu.supercluster.overpasser.library.query.OverpassFilterQuery

public class OverpassFilterQuery
extends java.lang.Object

Represents a sub-query to apply filters for type elements (node, way, relation, area), tag values, bounding boxes, etc.

See Also:

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OverpassFilterQuery(OverpassQuery parent)

Method Summary

Modifier and Type	Method and Description
OverpassFilterQuery	amenities(java.util.Set<java.lang.String> amenities) A convenience method filtering the output for multiple amenities.
OverpassFilterQuery	amenity(java.lang.String amenity) A convenience method filtering the output for a single amenity.
OverpassFilterQuery	area() Appends the string area to the current query.
OverpassFilterQuery	boundingBox(double southernLat, double westernLon, double northernLat, double easternLon) Adds a (southernLat,westernLon,northernLat,easternLon) bounding box filter to the current query.
java.lang.String	build() Closes the current query with the characters ;<;) and returns the output as a string.
OverpassQuery	end()
OverpassFilterQuery	node() Appends the string node to the current query.
void	onSubQueryResult(hu.supercluster.overpasser.library.query.AbstractOverpassSubQuery subQuery)
OverpassFilterQuery	prepareNext() When supplying multiple type elements in a query, use this method to automatically separate them with a ; character added in-between.
OverpassFilterQuery	rel() Appends the string rel to the current query.
OverpassFilterQuery	tag(java.lang.String name) Adds a ["name"] filter tag to the current query.
OverpassFilterQuery	tag(java.lang.String name, java.lang.String value) Adds a ["name"=value] filter tag to the current query.
OverpassFilterQuery	tagMultiple(java.lang.String name, java.util.Set<java.lang.String> values) Adds a ["name"~{value1}|{value2}|{value3}|...|{valueN}] filter tag to the current query to add a filter matching for any of the given values.
OverpassFilterQuery	tagNot(java.lang.String name, java.lang.String value) Adds a ["name"!=value] filter tag to the current query.
OverpassFilterQuery	tagRegex(java.lang.String name, java.lang.String value) Adds a ["name"~value] filter tag to the current query.
OverpassFilterQuery	tagRegexNot(java.lang.String name, java.lang.String value) Adds a ["name"!~value] filter tag to the current query.
OverpassFilterQuery	way() Appends the string way to the current query.

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

OverpassFilterQuery

public OverpassFilterQuery(OverpassQuery parent)

Method Detail

prepareNext

public OverpassFilterQuery prepareNext()

When supplying multiple type elements in a query, use this method to automatically separate them with a ; character added in-between.

Returns:

the current query object

node

public OverpassFilterQuery node()

Appends the string node to the current query.

Returns:

the current query object

rel

public OverpassFilterQuery rel()

Appends the string rel to the current query.

Returns:

the current query object

way

public OverpassFilterQuery way()

Appends the string way to the current query.

Returns:

the current query object

area

public OverpassFilterQuery area()

Appends the string area to the current query.

Returns:

the current query object

amenity

public OverpassFilterQuery amenity(java.lang.String amenity)

A convenience method filtering the output for a single amenity. It's equivalent to calling tag(String, String) with ("amenity", amenity)

Parameters:

amenity - the filter value

Returns:

the current query object

See Also:

amenities(Set)

amenities

public OverpassFilterQuery amenities(java.util.Set<java.lang.String> amenities)

A convenience method filtering the output for multiple amenities. It's equivalent to calling tagMultiple(String, Set) with ("amenity", amenities)

Parameters:

amenities - the filter values

Returns:

the current query object

tag

public OverpassFilterQuery tag(java.lang.String name)

Adds a ["name"] filter tag to the current query.

Parameters:

name - the filter name

Returns:

the current query object

tag

public OverpassFilterQuery tag(java.lang.String name,
                               java.lang.String value)

Adds a ["name"=value] filter tag to the current query.

Parameters:

name - the filter name

value - the filter value

Returns:

the current query object

tagMultiple

public OverpassFilterQuery tagMultiple(java.lang.String name,
                                       java.util.Set<java.lang.String> values)

Adds a ["name"~{value1}|{value2}|{value3}|...|{valueN}] filter tag to the current query to add a filter matching for any of the given values.

Parameters:

name - the filter name

values - the filter value

Returns:

the current query object

tagNot

public OverpassFilterQuery tagNot(java.lang.String name,
                                  java.lang.String value)

Adds a ["name"!=value] filter tag to the current query.

Parameters:

name - the filter name

value - the filter value

Returns:

the current query object

tagRegex

public OverpassFilterQuery tagRegex(java.lang.String name,
                                    java.lang.String value)

Adds a ["name"~value] filter tag to the current query.

Parameters:

name - the filter name

value - the filter value

Returns:

the current query object

tagRegexNot

public OverpassFilterQuery tagRegexNot(java.lang.String name,
                                       java.lang.String value)

Adds a ["name"!~value] filter tag to the current query.

Parameters:

name - the filter name

value - the filter value

Returns:

the current query object

boundingBox

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

Adds a (southernLat,westernLon,northernLat,easternLon) bounding box filter to the current query.

Parameters:

southernLat - the southern latitude

westernLon - the western longitude

northernLat - the northern latitude

easternLon - the eastern longitude

Returns:

the current query object

build

public java.lang.String build()

Closes the current query with the characters ;<;) and returns the output as a string.

Returns:

the query as string

end

public final OverpassQuery end()

onSubQueryResult

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