com.tomtom.online.sdk.search.data.geometry

Interface GeometrySearchQuery

All Superinterfaces:

com.tomtom.online.sdk.common.jni.JniNativeHandleOwner, com.tomtom.online.sdk.common.jni.NativeObject

All Known Implementing Classes:

GeometrySearchQueryBuilder

public interface GeometrySearchQuery
extends com.tomtom.online.sdk.common.jni.NativeObject

Field Summary

Fields inherited from interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

EMPTY_HANDLE

Method Summary

Modifier and Type	Method and Description
GeometrySearchQuery	withExtendedPostalCodesFor(java.lang.String extendedPostalCodesFor) Indexes for which extended postal codes should be included in the results.
GeometrySearchQuery	withIdxSet(java.lang.String idxSet) The "idxSet" parameter allows for fine tuning L2 by specifying which indexes to utilize for the search.
GeometrySearchQuery	withLanguage(java.lang.String language) Language in which search results should be returned.
GeometrySearchQuery	withLimit(int limit) Maximum number of responses that will be returned.
GeometrySearchQuery	withTypeAhead(boolean typeahead) If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.

Methods inherited from interface com.tomtom.online.sdk.common.jni.NativeObject

isAutoDisposable

Methods inherited from interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

dispose, getNativeHandle

Method Detail

withLimit

GeometrySearchQuery withLimit(int limit)

Maximum number of responses that will be returned.

Parameters:

limit - maximum number of responses that will be returned.

Returns:

the builder of the GeometrySearchQuery with new value for limit set.

withTypeAhead

GeometrySearchQuery withTypeAhead(boolean typeahead)

If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode. Default value: false

Parameters:

typeahead - predictive mode.

Returns:

the builder of the GeometrySearchQuery with new value for typeahead set.

withLanguage

GeometrySearchQuery withLanguage(java.lang.String language)

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 langauge is used.

Parameters:

language - language in which search results should be returned.

Returns:

the builder of the GeometrySearchQuery with new value for language set.

withExtendedPostalCodesFor

GeometrySearchQuery withExtendedPostalCodesFor(java.lang.String extendedPostalCodesFor)

Indexes for which extended postal codes should be included in the results. Available indexes are: Addr, Geo, PAD, POI, Str, XStr. E.g., extendedPostalCodesFor=PAD,Addr,POI Availability is region-dependent.

Parameters:

extendedPostalCodesFor - indexes for which extended postal codes should be included in the results.

Returns:

the builder of the GeometrySearchQuery with new value for extendedPostalCodesFor set.

withIdxSet

GeometrySearchQuery withIdxSet(java.lang.String idxSet)

The "idxSet" parameter allows for fine tuning L2 by specifying which indexes to utilize for the search. Comma-separated, f.e. idxSet=POI,PAD,Str,Xstr,Geo,Addr

Parameters:

idxSet - indexes to utilize for the search.

Returns:

the builder of the GeometrySearchQuery with new value for idxSet set.