com.tomtom.online.sdk.search.data

Interface ReverseGeocoderQuery

All Known Implementing Classes:

ReverseGeocoderQueryBuilder

public interface ReverseGeocoderQuery

ReverseGeocoderQuery is an interface designed to transfer SearchAPI parameters in a readable manner by implementing class: ReverseGeocoderQueryBuilder.
The ReverseGeocoderQuery instance can be constructed using the associated ReverseGeocoderQueryBuilder class. Once constructed, the user cannot change the field values.

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
ReverseGeocoderQuery	withHeading(int heading) The directional heading of the vehicle in degrees, for travel along a segment of roadway.
ReverseGeocoderQuery	withLanguagePrefix(java.lang.String languagePrefix) Language in which search results should be returned.
ReverseGeocoderQuery	withRadius(int radius) If the radius is set, the results will be constrained to the defined area.
ReverseGeocoderQuery	withReturnMatchType(boolean returnMatchType) Enable return of address match type information.
ReverseGeocoderQuery	withReturnRoadUse(boolean returnRoadUse) To enable return of the road use array for reversegeocodes at street level.
ReverseGeocoderQuery	withReturnSpeedLimit(boolean returnSpeedLimit) To enable return of the posted speedlimit (where available).
ReverseGeocoderQuery	withTolerance(boolean tolerance) The tolerance, in degrees, to either side of the direction specified by angle.

Method Detail

getNativeHandle

long getNativeHandle()

Handle of native pointer address

Returns:

long value which represents the native handler

Dispose

void Dispose()

Disposes the ReverseGeocoderQuery class which was constructed at native layer

withRadius

ReverseGeocoderQuery withRadius(int radius)

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

Parameters:

radius - Value in meters, no default value.

Returns:

the builder of the ReverseGeocoderQuery with new value for radius set

withLanguagePrefix

ReverseGeocoderQuery 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.

Parameters:

languagePrefix -

Returns:

the builder of the ReverseGeocoderQuery with new value for languagePrefix set

withHeading

ReverseGeocoderQuery 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.

Parameters:

heading -

Returns:

the builder of the ReverseGeocoderQuery with new value for heading set

withReturnSpeedLimit

ReverseGeocoderQuery withReturnSpeedLimit(boolean returnSpeedLimit)

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

Parameters:

returnSpeedLimit - speed limit at reverse geocoded location

Returns:

the builder of the ReverseGeocoderQuery with new value for returnSpeedLimit set

withReturnRoadUse

ReverseGeocoderQuery withReturnRoadUse(boolean returnRoadUse)

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

Parameters:

returnRoadUse -

Returns:

the builder of the ReverseGeocoderQuery with new value for returnRoadUse set

withTolerance

ReverseGeocoderQuery 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.

Parameters:

tolerance -

Returns:

the builder of the ReverseGeocoderQuery with new value for tolerance set

withReturnMatchType

ReverseGeocoderQuery withReturnMatchType(boolean returnMatchType)

Enable return of address match type information.

Parameters:

returnMatchType -

Returns:

the builder of the ReverseGeocoderQuery with new value for returnMatchType set