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

Class FuzzySearchQueryBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class FuzzySearchQueryBuilder
extends java.lang.Object
implements FuzzySearchQuery

Builder class used to create FuzzySearchQuery.

Constructor Summary

Constructors

Constructor and Description
FuzzySearchQueryBuilder(java.lang.String term)

Method Summary

Modifier and Type	Method and Description
void	dispose()
long	getNativeHandle()
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 extendedPostalCodesFor) 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 class java.lang.Object

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

Constructor Detail

FuzzySearchQueryBuilder

public FuzzySearchQueryBuilder(java.lang.String term)

Method Detail

getNativeHandle

public long getNativeHandle()

Specified by:

getNativeHandle in interface com.tomtom.online.sdk.common.jni.NativeObject

dispose

public void dispose()

Specified by:

dispose in interface com.tomtom.online.sdk.common.jni.NativeObject

withLimit

public FuzzySearchQuery withLimit(int limit)

Description copied from interface: FuzzySearchQuery

The upper limit of the number of results.

Specified by:

withLimit in interface FuzzySearchQuery

Parameters:

limit - upper limit of the number of results.

Returns:

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

withOffset

public FuzzySearchQuery withOffset(int offset)

Description copied from interface: FuzzySearchQuery

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

Specified by:

withOffset in interface FuzzySearchQuery

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

public FuzzySearchQuery withPosition(LatLng position)

Description copied from interface: FuzzySearchQuery

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

Specified by:

withPosition in interface FuzzySearchQuery

Parameters:

position - position where results should be biased.

Returns:

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

withPosition

public FuzzySearchQuery withPosition(LatLng position,
                                     int radius)

Description copied from interface: FuzzySearchQuery

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.

Specified by:

withPosition in interface FuzzySearchQuery

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

public FuzzySearchQuery withCountry(java.lang.String country)

Description copied from interface: FuzzySearchQuery

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

Specified by:

withCountry in interface FuzzySearchQuery

Parameters:

country - string with country codes.

Returns:

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

withExtendedPostalCodes

public FuzzySearchQuery withExtendedPostalCodes(java.lang.String extendedPostalCodesFor)

Description copied from interface: FuzzySearchQuery

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"

Specified by:

withExtendedPostalCodes in interface FuzzySearchQuery

Parameters:

extendedPostalCodesFor - string with postal codes.

Returns:

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

withIdx

public FuzzySearchQuery withIdx(java.lang.String idxSet)

Description copied from interface: FuzzySearchQuery

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

Specified by:

withIdx in interface FuzzySearchQuery

Parameters:

idxSet - indexes to be utilized for the search.

Returns:

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

withBoundingBox

public FuzzySearchQuery withBoundingBox(LatLng topLeft,
                                        LatLng bottomRight)

Description copied from interface: FuzzySearchQuery

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.

Specified by:

withBoundingBox in interface FuzzySearchQuery

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

public FuzzySearchQuery withTypeAhead(boolean isTypeAhead)

Description copied from interface: FuzzySearchQuery

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

Specified by:

withTypeAhead in interface FuzzySearchQuery

Parameters:

isTypeAhead - whether the predictive mode is enabled.

Returns:

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

withCategory

public FuzzySearchQuery withCategory(boolean isCategory)

Description copied from interface: FuzzySearchQuery

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

Specified by:

withCategory in interface FuzzySearchQuery

Parameters:

isCategory - whether the category search is enabled.

Returns:

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

withLanguage

public FuzzySearchQuery withLanguage(java.lang.String language)

Description copied from interface: FuzzySearchQuery

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.

Specified by:

withLanguage in interface FuzzySearchQuery

Parameters:

language - language in which search results should be returned.

Returns:

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

withMinFuzzyLevel

public FuzzySearchQuery withMinFuzzyLevel(int minFuzzyLevel)

Description copied from interface: FuzzySearchQuery

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

Specified by:

withMinFuzzyLevel in interface FuzzySearchQuery

Parameters:

minFuzzyLevel - minimum fuzzyness level to be used.

Returns:

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

withMaxFuzzyLevel

public FuzzySearchQuery withMaxFuzzyLevel(int maxFuzzyLevel)

Description copied from interface: FuzzySearchQuery

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

Specified by:

withMaxFuzzyLevel in interface FuzzySearchQuery

Parameters:

maxFuzzyLevel - maximum fuzzyness level to be used.

Returns:

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