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

Class ReverseGeocoderSearchQueryBuilder

java.lang.Object

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

All Implemented Interfaces:

ReverseGeocoderSearchQuery

public class ReverseGeocoderSearchQueryBuilder
extends java.lang.Object
implements ReverseGeocoderSearchQuery

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

Constructor Summary

Constructors

Constructor and Description
ReverseGeocoderSearchQueryBuilder(double latitude, double longitude)

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes the Query class which was constructed at native layer
ReverseGeocoderSearchQuery	withCallback(java.lang.String callback) Specifies the jsonp callback method.
ReverseGeocoderSearchQuery	withHeading(float heading) The directional heading of the vehicle in degrees, for travel along a segment of roadway.
ReverseGeocoderSearchQuery	withLanguagePrefix(java.lang.String languagePrefix) Language in which search results should be returned.
ReverseGeocoderSearchQuery	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.
ReverseGeocoderSearchQuery	withRadius(int radius) If the radius is set, the results will be constrained to the defined area.
ReverseGeocoderSearchQuery	withReturnRoadUse(boolean returnRoadUse) To enable return of the road use array for reversegeocodes at street level.
ReverseGeocoderSearchQuery	withReturnSpeedLimit(boolean returnSpeedLimit) To enable return of the posted speedlimit (where available).
ReverseGeocoderSearchQuery	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

Methods inherited from interface com.tomtom.online.sdk.search.data.reversegeocoder.ReverseGeocoderSearchQuery

getNativeHandle

Constructor Detail

ReverseGeocoderSearchQueryBuilder

public ReverseGeocoderSearchQueryBuilder(double latitude,
                                         double longitude)

Method Detail

dispose

public void dispose()

Description copied from interface: ReverseGeocoderSearchQuery

Disposes the Query class which was constructed at native layer

Specified by:

dispose in interface ReverseGeocoderSearchQuery

withRadius

public ReverseGeocoderSearchQuery withRadius(int radius)

Description copied from interface: ReverseGeocoderSearchQuery

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

Specified by:

withRadius in interface ReverseGeocoderSearchQuery

Parameters:

radius - Value in meters, no default value.

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for radius set

withLanguagePrefix

public ReverseGeocoderSearchQuery withLanguagePrefix(java.lang.String languagePrefix)

Description copied from interface: ReverseGeocoderSearchQuery

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 ReverseGeocoderSearchQuery

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for languagePrefix set

withHeading

public ReverseGeocoderSearchQuery withHeading(float heading)

Description copied from interface: ReverseGeocoderSearchQuery

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 ReverseGeocoderSearchQuery

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for heading set

withNumber

public ReverseGeocoderSearchQuery withNumber(java.lang.String number)

Description copied from interface: ReverseGeocoderSearchQuery

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 ReverseGeocoderSearchQuery

Parameters:

number - the side of the street

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for number set

withReturnSpeedLimit

public ReverseGeocoderSearchQuery withReturnSpeedLimit(boolean returnSpeedLimit)

Description copied from interface: ReverseGeocoderSearchQuery

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

Specified by:

withReturnSpeedLimit in interface ReverseGeocoderSearchQuery

Parameters:

returnSpeedLimit - speed limit at reverse geocoded location

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for returnSpeedLimit set

withReturnRoadUse

public ReverseGeocoderSearchQuery withReturnRoadUse(boolean returnRoadUse)

Description copied from interface: ReverseGeocoderSearchQuery

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

Specified by:

withReturnRoadUse in interface ReverseGeocoderSearchQuery

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for returnRoadUse set

withRoadUse

public ReverseGeocoderSearchQuery withRoadUse(java.lang.String roadUse)

Description copied from interface: ReverseGeocoderSearchQuery

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 ReverseGeocoderSearchQuery

Parameters:

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

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for roadUse set

withCallback

public ReverseGeocoderSearchQuery withCallback(java.lang.String callback)

Description copied from interface: ReverseGeocoderSearchQuery

Specifies the jsonp callback method.

Specified by:

withCallback in interface ReverseGeocoderSearchQuery

Parameters:

callback - jsonp callback method

Returns:

the builder of the ReverseGeocoderSearchQuery with new value for callback set