com.tomtom.online.sdk.search.data.fuzzy

Interface FuzzySearchQuery

All Superinterfaces:

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

All Known Implementing Classes:

FuzzySearchQueryBuilder

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

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

Method Summary

Modifier and Type	Method and Description
FuzzySearchQuery	withBoundingBox(LatLng topLeft, LatLng bottomRight) The boundin box for the search.
FuzzySearchQuery	withCategory(boolean isCategory) If your search use case only requires POI results filtered by category, you may use the category endpoint.
FuzzySearchQuery	withCountry(java.lang.String country) Comma separated string of country codes (eg: FR,ES).
FuzzySearchQuery	withExtendedPostalCodes(java.lang.String extPostalCodesFor) Indexes for which extended postal codes should be included in the results.
FuzzySearchQuery	withIdx(java.lang.String idxSet) A comma separated list of indexes which should be utilized for the search.
FuzzySearchQuery	withLanguage(java.lang.String language) Language in which search results should be returned.
FuzzySearchQuery	withLimit(int limit) The upper limit of the number of results.
FuzzySearchQuery	withMaxFuzzyLevel(int maxFuzzyLevel) Maximum fuzzyness level to be used.
FuzzySearchQuery	withMinFuzzyLevel(int minFuzzyLevel) Minimum fuzzyness level to be used.
FuzzySearchQuery	withOffset(int offset) Starting offset of the returned results within the full result set.
FuzzySearchQuery	withPosition(LatLng position) The position where results should be biased.
FuzzySearchQuery	withPosition(LatLng position, int radius) The position where results should be biased.
FuzzySearchQuery	withTypeAhead(boolean isTypeAhead) 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

dispose, getNativeHandle

Method Detail

withLimit

FuzzySearchQuery withLimit(int limit)

The upper limit of the number of results.

Parameters:

limit - upper limit of the number of results.

Returns:

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

withOffset

FuzzySearchQuery withOffset(int offset)

Starting offset of the returned results within the full result set.

Parameters:

offset - starting offset of the returned results within the full result set.

Returns:

the builder of the query with new value for offset set.

withPosition

FuzzySearchQuery withPosition(LatLng position)

The position where results should be biased. Supplying the position without a radius will only bias the search results to that area.

Parameters:

position - position where results should be biased.

Returns:

the builder of the query with new value for position set.

withPosition

FuzzySearchQuery withPosition(LatLng position,
                              int radius)

The position where results should be biased. The radius parameter is specified in meters. If radius and position are set, the results will be constrained to the defined area. If radius is not present or is set to 0, the results will not be constrained.

Parameters:

position - position where results should be biased.

radius - search radius.

Returns:

the builder of the query with new values for position and radius set.

withCountry

FuzzySearchQuery withCountry(java.lang.String country)

Comma separated string of country codes (eg: FR,ES). This will limit the search to the specified countries.

Parameters:

country - string with country codes.

Returns:

the builder of the query with new value for country set.

withIdx

FuzzySearchQuery withIdx(java.lang.String idxSet)

A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr, Geo, PAD, POI, Str , Xstr, i.e. "PAD,Addr".

Parameters:

idxSet - indexes to be utilized for the search.

Returns:

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

withBoundingBox

FuzzySearchQuery withBoundingBox(LatLng topLeft,
                                 LatLng bottomRight)

The boundin box for the search. NOTE: Point-Radius parameters and bounding box parameters are mutually exclusive, point radius parameters take precendence when both are passed in.

Parameters:

topLeft - top left position of the bounding box.

bottomRight - bottom right position of the bounding box.

Returns:

the builder of the query with new value for bounding box set.

withTypeAhead

FuzzySearchQuery withTypeAhead(boolean isTypeAhead)

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

Parameters:

isTypeAhead - whether the predictive mode is enabled.

Returns:

the builder of the query with new value for isTypeAhead set.

withCategory

FuzzySearchQuery withCategory(boolean isCategory)

If your search use case only requires POI results filtered by category, you may use the category endpoint.

Parameters:

isCategory - whether the category search is enabled.

Returns:

the builder of the query with new value for isCategory set.

withLanguage

FuzzySearchQuery 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 query with new value for language set.

withExtendedPostalCodes

FuzzySearchQuery withExtendedPostalCodes(java.lang.String extPostalCodesFor)

Indexes for which extended postal codes should be included in the results. Available indexes are: Addr, Geo, PAD, POI, Str, XStr. Value should be a comma separated list of index types (in any order) or "None" for no indexes, i.e. "PAD,Addr,POI"

Parameters:

extPostalCodesFor - string with postal codes.

Returns:

the builder of the query with new value for postal codes.

withMinFuzzyLevel

FuzzySearchQuery withMinFuzzyLevel(int minFuzzyLevel)

Minimum fuzzyness level to be used. The default value is 1, the maximum value is 4

Parameters:

minFuzzyLevel - minimum fuzzyness level to be used.

Returns:

the builder of the query with new value for minFuzzyLevel set.

withMaxFuzzyLevel

FuzzySearchQuery withMaxFuzzyLevel(int maxFuzzyLevel)

Maximum fuzzyness level to be used. The default value is 2, the maximum value is 4

Parameters:

maxFuzzyLevel - maximum fuzzyness level to be used.

Returns:

the builder of the query with new value for maxFuzzyLevel set.