com.tomtom.online.sdk.search.data

Class ReverseGeocoderQueryBuilder

java.lang.Object

com.tomtom.online.sdk.search.data.ReverseGeocoderQueryBuilder

All Implemented Interfaces:

ReverseGeocoderQuery

public class ReverseGeocoderQueryBuilder
extends java.lang.Object
implements ReverseGeocoderQuery

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

Constructor Summary

Constructors

Constructor and Description
ReverseGeocoderQueryBuilder(double latitude, double longitude)

Method Summary

Modifier and Type	Method and Description
void	Dispose() Disposes the ReverseGeocoderQuery class which was constructed at native layer
long	getNativeHandle() Handle of native pointer address
ReverseGeocoderQueryBuilder	withHeading(int heading) The directional heading of the vehicle in degrees, for travel along a segment of roadway.
ReverseGeocoderQueryBuilder	withLanguagePrefix(java.lang.String languagePrefix) Language in which search results should be returned.
ReverseGeocoderQueryBuilder	withRadius(int radius) If the radius is set, the results will be constrained to the defined area.
ReverseGeocoderQueryBuilder	withReturnMatchType(boolean returnMatchType) Enable return of address match type information.
ReverseGeocoderQueryBuilder	withReturnRoadUse(boolean returnRoadUse) To enable return of the road use array for reversegeocodes at street level.
ReverseGeocoderQueryBuilder	withReturnSpeedLimit(boolean returnSpeedLimit) To enable return of the posted speedlimit (where available).
ReverseGeocoderQueryBuilder	withTolerance(boolean tolerance) The tolerance, in degrees, to either side of the direction specified by angle.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReverseGeocoderQueryBuilder

public ReverseGeocoderQueryBuilder(double latitude,
                                   double longitude)

Method Detail

Dispose

public void Dispose()

Disposes the ReverseGeocoderQuery class which was constructed at native layer

Specified by:

Dispose in interface ReverseGeocoderQuery

withRadius

public ReverseGeocoderQueryBuilder withRadius(int radius)

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

Specified by:

withRadius in interface ReverseGeocoderQuery

Parameters:

radius - Value in meters, no default value.

Returns:

the builder of the ReverseGeocoderQuery with new value for radius set

withLanguagePrefix

public ReverseGeocoderQueryBuilder withLanguagePrefix(java.lang.String languagePrefix)

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 ReverseGeocoderQuery

Returns:

the builder of the ReverseGeocoderQuery with new value for languagePrefix set

withHeading

public ReverseGeocoderQueryBuilder withHeading(int heading)

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 ReverseGeocoderQuery

Returns:

the builder of the ReverseGeocoderQuery with new value for heading set

withReturnSpeedLimit

public ReverseGeocoderQueryBuilder withReturnSpeedLimit(boolean returnSpeedLimit)

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

Specified by:

withReturnSpeedLimit in interface ReverseGeocoderQuery

Parameters:

returnSpeedLimit - speed limit at reverse geocoded location

Returns:

the builder of the ReverseGeocoderQuery with new value for returnSpeedLimit set

withReturnRoadUse

public ReverseGeocoderQueryBuilder withReturnRoadUse(boolean returnRoadUse)

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

Specified by:

withReturnRoadUse in interface ReverseGeocoderQuery

Returns:

the builder of the ReverseGeocoderQuery with new value for returnRoadUse set

withTolerance

public ReverseGeocoderQueryBuilder withTolerance(boolean tolerance)

The tolerance, in degrees, to either side of the direction specified by angle. The default is 22.5. Currently, tolerance is ignored.

Specified by:

withTolerance in interface ReverseGeocoderQuery

Returns:

the builder of the ReverseGeocoderQuery with new value for tolerance set

withReturnMatchType

public ReverseGeocoderQueryBuilder withReturnMatchType(boolean returnMatchType)

Enable return of address match type information.

Specified by:

withReturnMatchType in interface ReverseGeocoderQuery

Returns:

the builder of the ReverseGeocoderQuery with new value for returnMatchType set

getNativeHandle

public long getNativeHandle()

Description copied from interface: ReverseGeocoderQuery

Handle of native pointer address

Specified by:

getNativeHandle in interface ReverseGeocoderQuery

Returns:

long value which represents the native handler