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

Interface IReverseGeocoderSearchQuery

public interface IReverseGeocoderSearchQuery

ReverseGeocoderSearchQuery is an interface designed to transfer Search API parameters in a readable manner by implementing the Class: ReverseGeocoderSearchQueryBuilder.
The ReverseGeocoderSearchQuery instance can be constructed using the associated ReverseGeocoderSearchQueryBuilder Class. Once constructed, the user cannot change the field values.

Method Summary

Modifier and Type	Method and Description
IReverseGeocoderSearchQuery	withHeading(java.lang.Float heading) The directional heading of the vehicle in degrees while traveling along a segment of roadway.
IReverseGeocoderSearchQuery	withLanguagePrefix(java.lang.String languagePrefix) The language in which search results should be returned.
IReverseGeocoderSearchQuery	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.
IReverseGeocoderSearchQuery	withRadius(java.lang.Integer radius) If the radius is set, the results will be constrained to the defined area.
IReverseGeocoderSearchQuery	withReturnRoadUse(java.lang.Boolean returnRoadUse) Enables the return of the road use array for reversegeocodes at street level.
IReverseGeocoderSearchQuery	withReturnSpeedLimit(java.lang.Boolean returnSpeedLimit) Enables the return of the posted speedlimit (where available).
IReverseGeocoderSearchQuery	withRoadUse(java.lang.String roadUse) Restricts reversegeocodes to a certain type of roaduse.

Method Detail

withRadius

@NonNull
IReverseGeocoderSearchQuery withRadius(java.lang.Integer radius)

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

Parameters:

radius - A value in meters with no default value.

Returns:

The builder of the ReverseGeocoderSearchQuery with a new value for radius being set.

withLanguagePrefix

@NonNull
IReverseGeocoderSearchQuery withLanguagePrefix(java.lang.String languagePrefix)

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

Parameters:

languagePrefix -

Returns:

The builder of the ReverseGeocoderSearchQuery with a new value for languagePrefix being set.

withHeading

@NonNull
IReverseGeocoderSearchQuery withHeading(java.lang.Float heading)

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

Parameters:

heading -

Returns:

The builder of the ReverseGeocoderSearchQuery with a new value for heading being set.

withNumber

@NonNull
IReverseGeocoderSearchQuery 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.

Parameters:

number - The side of the street.

Returns:

The builder of the ReverseGeocoderSearchQuery with a new value for number being set.

withReturnSpeedLimit

@NonNull
IReverseGeocoderSearchQuery withReturnSpeedLimit(java.lang.Boolean returnSpeedLimit)

Enables the return of the posted speedlimit (where available).

Parameters:

returnSpeedLimit - The speed limit at a reverse geocoded location.

Returns:

The builder of the ReverseGeocoderSearchQuery with a new value for returnSpeedLimit being set.

withReturnRoadUse

@NonNull
IReverseGeocoderSearchQuery withReturnRoadUse(java.lang.Boolean returnRoadUse)

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

Parameters:

returnRoadUse -

Returns:

The builder of the ReverseGeocoderSearchQuery with a new value for returnRoadUse being set.

withRoadUse

@NonNull
IReverseGeocoderSearchQuery withRoadUse(java.lang.String roadUse)

Restricts 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"].

Parameters:

roadUse - For example: "LimitedAccess,Arterial,Terminal"

Returns:

The builder of the ReverseGeocoderSearchQuery with a new value for roadUse being set.