com.tomtom.online.sdk.search.data.reversegeocoder

Class ReverseGeocoderSearchQueryBuilder

java.lang.Object

com.tomtom.online.sdk.search.data.reversegeocoder.ReverseGeocoderSearchQueryBuilder

All Implemented Interfaces:

IReverseGeocoderSearchQuery

public class ReverseGeocoderSearchQueryBuilder
extends java.lang.Object
implements IReverseGeocoderSearchQuery

The default builder for ReverseGeocoderSearchQuery objects.

Constructor Summary

Constructors

Constructor and Description
ReverseGeocoderSearchQueryBuilder(double latitude, double longitude)

Method Summary

Modifier and Type	Method and Description
ReverseGeocoderSearchQuery	build() Creates new instance of ReverseGeocoderSearchQuery
static ReverseGeocoderSearchQueryBuilder	create(double latitude, double longitude) Builder used to create an instance of ReverseGeocoderSearchQuery, once constructed, the user cannot change the field values
ReverseGeocoderSearchQueryBuilder	withEntityType(java.lang.String entityType)
ReverseGeocoderSearchQueryBuilder	withGeopoliticalView(java.lang.String geopoliticalView)
ReverseGeocoderSearchQueryBuilder	withHeading(java.lang.Float heading) The directional heading of the vehicle in degrees, for travel along a segment of roadway.
ReverseGeocoderSearchQueryBuilder	withLanguagePrefix(java.lang.String languagePrefix) Language in which search results should be returned.
ReverseGeocoderSearchQueryBuilder	withNumber(java.lang.String number) If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number.
ReverseGeocoderSearchQueryBuilder	withRadius(java.lang.Integer radius) If the radius is set, the results will be constrained to the defined area.
ReverseGeocoderSearchQueryBuilder	withReturnRoadUse(java.lang.Boolean returnRoadUse) To enable return of the road use array for reversegeocodes at street level.
ReverseGeocoderSearchQueryBuilder	withReturnSpeedLimit(java.lang.Boolean returnSpeedLimit) To enable return of the posted speedlimit (where available).
ReverseGeocoderSearchQueryBuilder	withRoadUse(java.lang.String roadUse) To restrict reversegeocodes to a certain type of roaduse.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReverseGeocoderSearchQueryBuilder

public ReverseGeocoderSearchQueryBuilder(double latitude,
                                         double longitude)

Method Detail

withRadius

public ReverseGeocoderSearchQueryBuilder withRadius(java.lang.Integer radius)

Description copied from interface: IReverseGeocoderSearchQuery

If the radius is set, the results will be constrained to the defined area.

Specified by:

withRadius in interface IReverseGeocoderSearchQuery

Parameters:

radius - Value in meters, no default value.

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for radius set

withLanguagePrefix

public ReverseGeocoderSearchQueryBuilder withLanguagePrefix(java.lang.String languagePrefix)

Description copied from interface: IReverseGeocoderSearchQuery

Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.

Specified by:

withLanguagePrefix in interface IReverseGeocoderSearchQuery

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for languagePrefix set

withHeading

public ReverseGeocoderSearchQueryBuilder withHeading(java.lang.Float heading)

Description copied from interface: IReverseGeocoderSearchQuery

The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place.

Specified by:

withHeading in interface IReverseGeocoderSearchQuery

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for heading set

withNumber

public ReverseGeocoderSearchQueryBuilder withNumber(java.lang.String number)

Description copied from interface: IReverseGeocoderSearchQuery

If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number.

Specified by:

withNumber in interface IReverseGeocoderSearchQuery

Parameters:

number - the side of the street

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for number set

withReturnSpeedLimit

public ReverseGeocoderSearchQueryBuilder withReturnSpeedLimit(java.lang.Boolean returnSpeedLimit)

Description copied from interface: IReverseGeocoderSearchQuery

To enable return of the posted speedlimit (where available).

Specified by:

withReturnSpeedLimit in interface IReverseGeocoderSearchQuery

Parameters:

returnSpeedLimit - speed limit at reverse geocoded location

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for returnSpeedLimit set

withReturnRoadUse

public ReverseGeocoderSearchQueryBuilder withReturnRoadUse(java.lang.Boolean returnRoadUse)

Description copied from interface: IReverseGeocoderSearchQuery

To enable return of the road use array for reversegeocodes at street level.

Specified by:

withReturnRoadUse in interface IReverseGeocoderSearchQuery

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for returnRoadUse set

withRoadUse

public ReverseGeocoderSearchQueryBuilder withRoadUse(java.lang.String roadUse)

Description copied from interface: IReverseGeocoderSearchQuery

To restrict reversegeocodes to a certain type of roaduse. The road use array for reversegeocodes can be one or more of: ["LimitedAccess", "Arterial", "Terminal", "Ramp", "Rotary", "LocalStreet"].

Specified by:

withRoadUse in interface IReverseGeocoderSearchQuery

Parameters:

roadUse - f.e. "LimitedAccess,Arterial,Terminal"

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for roadUse set

withEntityType

public ReverseGeocoderSearchQueryBuilder withEntityType(java.lang.String entityType)

withGeopoliticalView

public ReverseGeocoderSearchQueryBuilder withGeopoliticalView(java.lang.String geopoliticalView)

create

public static ReverseGeocoderSearchQueryBuilder create(double latitude,
                                                       double longitude)

Builder used to create an instance of ReverseGeocoderSearchQuery, once constructed, the user cannot change the field values

Parameters:

origins - list of origin locations used to calculate matrix routes.

destinations - list of destination locations used to calculate matrix routes.

Returns:

newly created builder object for ReverseGeocoderSearchQuery to be used for further processing

build

public ReverseGeocoderSearchQuery build()

Creates new instance of ReverseGeocoderSearchQuery