fr.dudie.nominatim.client.request

Class NominatimSearchRequest

java.lang.Object

fr.dudie.nominatim.client.request.NominatimRequest

fr.dudie.nominatim.client.request.NominatimSearchRequest

public class NominatimSearchRequest
extends NominatimRequest

Holds request parameters for a search request.

Attributes documentation was extracted from Nominatim Wiki page on October 26th, 2013.

Author:

Jeremie Huchet

Constructor Summary

Constructors

Constructor and Description
NominatimSearchRequest()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCountryCode(String countryCode) Limit search results to a specific country (or a list of countries).
void	addExcludedlaceId(String placeId) If you do not want certain openstreetmap objects to appear in the search result, give a list of the place_id's you want to skip.
String	getAcceptLanguage() Gets the preferred language order for showing search results which overrides the browser value.
boolean	getAddress() When true, include a breakdown of the address into elements.
Boolean	getBounded() Gets whether or not the results will be bounded to the given viewBox.
List<String>	getCountryCodes() Gets the country codes.
List<String>	getExcludePlaceIds() A list of OSM elements ids to be excluded from search results.
Integer	getLimit() Gets the maximum number of results to be returned.
Boolean	getName() When true, include a list of alternative names in the results.
PolygonFormat	getPolygonFormat() Gets the output geometry format.
fr.dudie.nominatim.client.request.SearchQuery	getQuery() Gets the query parameters.
BoundingBox	getViewBox() Gets the preferred area to find search results.
void	setAcceptLanguage(String acceptLanguage) Sets the preferred language order for showing search results, overrides the browser value.
void	setAddress(boolean address) Include a breakdown of the address into elements.
void	setBounded(boolean bounded) Setting true will restrict the results to only items contained with the bounding box.
void	setCountryCodes(List<String> countryCodes) Limit search results to a specific country (or a list of countries).
void	setExcludePlaceIds(List<String> excludePlaceIds) If you do not want certain openstreetmap objects to appear in the search result, give a list of the place_id's you want to skip.
void	setLimit(Integer limit) Limit the number of returned results.
void	setName(Boolean name) Include a list of alternative names in the results.
void	setPolygonFormat(PolygonFormat polygonFormat) Choose output geometry format.
void	setQuery(fr.dudie.nominatim.client.request.SearchQuery query) Sets query parameters.
void	setQuery(String simpleQuery) Sets a simple query.
void	setViewBox(BoundingBox viewBox) Sets the preferred area to find search results;
void	setViewBox(double west, double north, double east, double south) Sets the preferred area to find search results;
void	setViewBox(int westE6, int northE6, int eastE6, int southE6) Sets the preferred area to find search results;

Methods inherited from class fr.dudie.nominatim.client.request.NominatimRequest

getQueryString

Methods inherited from class java.lang.Object

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

Constructor Detail

NominatimSearchRequest

public NominatimSearchRequest()

Method Detail

getQuery

public fr.dudie.nominatim.client.request.SearchQuery getQuery()

Gets the query parameters.

Returns:

the query parameters

setQuery

public void setQuery(fr.dudie.nominatim.client.request.SearchQuery query)

Sets query parameters.

Parameters:

query - the query parameters object holder

setQuery

public void setQuery(String simpleQuery)

Sets a simple query.

Parameters:

simpleQuery - the query string, such as Rennes, France

getAcceptLanguage

public String getAcceptLanguage()

Gets the preferred language order for showing search results which overrides the browser value.

Returns:

the accept-language value

setAcceptLanguage

public void setAcceptLanguage(String acceptLanguage)

Sets the preferred language order for showing search results, overrides the browser value.

Parameters:

acceptLanguage - a standard rfc2616 accept-language string or a simple comma separated list of language codes

getCountryCodes

public List<String> getCountryCodes()

Gets the country codes.

Returns:

the country codes

setCountryCodes

public void setCountryCodes(List<String> countryCodes)

Limit search results to a specific country (or a list of countries). <countrycode> should be the ISO 3166-1alpha2 code, e.g. gb for the United Kingdom, de for Germany, etc.

Parameters:

countryCodes - the country codes to set

addCountryCode

public void addCountryCode(String countryCode)

Limit search results to a specific country (or a list of countries). <countrycode> should be the ISO 3166-1alpha2 code, e.g. gb for the United Kingdom, de for Germany, etc.

Parameters:

countryCode - the country code to add

getViewBox

public BoundingBox getViewBox()

Gets the preferred area to find search results.

Returns:

the viewBox the preferred area to find search results

setViewBox

public void setViewBox(BoundingBox viewBox)

Sets the preferred area to find search results;

Parameters:

viewBox - the vthe preferred area to find search results to set

setViewBox

public void setViewBox(double west,
              double north,
              double east,
              double south)

Sets the preferred area to find search results;

Parameters:

west - the west bound

north - the north bound

east - the east bound

south - the south bound

setViewBox

public void setViewBox(int westE6,
              int northE6,
              int eastE6,
              int southE6)

Sets the preferred area to find search results;

Parameters:

westE6 - the west bound

northE6 - the north bound

eastE6 - the east bound

southE6 - the south bound

getBounded

public Boolean getBounded()

Gets whether or not the results will be bounded to the given viewBox.

Returns:

the bounded

setBounded

public void setBounded(boolean bounded)

Setting true will restrict the results to only items contained with the bounding box.
Restricting the results to the bounding box also enables searching by amenity only.
For example a search query of just "[pub]" would normally be rejected but with bounded=1 will result in a list of items matching within the bounding box.

Parameters:

bounded - the bounded to set

getAddress

public boolean getAddress()

When true, include a breakdown of the address into elements.

Returns:

the address

setAddress

public void setAddress(boolean address)

Include a breakdown of the address into elements.

Parameters:

address - the address to set

getName

public Boolean getName()

When true, include a list of alternative names in the results.

Returns:

setName

public void setName(Boolean name)

Include a list of alternative names in the results.

Parameters:

name -

getExcludePlaceIds

public List<String> getExcludePlaceIds()

A list of OSM elements ids to be excluded from search results.

Returns:

the excluded place ids

setExcludePlaceIds

public void setExcludePlaceIds(List<String> excludePlaceIds)

If you do not want certain openstreetmap objects to appear in the search result, give a list of the place_id's you want to skip.

Parameters:

excludePlaceIds - the excluded place ids to set

addExcludedlaceId

public void addExcludedlaceId(String placeId)

If you do not want certain openstreetmap objects to appear in the search result, give a list of the place_id's you want to skip.

Parameters:

placeId - the place id to exclude

getLimit

public Integer getLimit()

Gets the maximum number of results to be returned.

Returns:

the limit

setLimit

public void setLimit(Integer limit)

Limit the number of returned results.

Parameters:

limit - the limit to set

getPolygonFormat

public PolygonFormat getPolygonFormat()

Gets the output geometry format.

Returns:

the polygon format

setPolygonFormat

public void setPolygonFormat(PolygonFormat polygonFormat)

Choose output geometry format.

Parameters:

polygonFormat - the polygon format to set