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

Class FuzzySearchQueryBuilder

java.lang.Object

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

All Implemented Interfaces:

IFuzzySearchQuery

public class FuzzySearchQueryBuilder
extends java.lang.Object
implements IFuzzySearchQuery

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
FuzzySearchQuery	build() Creates new instance of FuzzySearchQuery
static FuzzySearchQueryBuilder	create(java.lang.String term) Builder used to create an instance of FuzzySearchQuery, once constructed, the user cannot change the field values
FuzzySearchQueryBuilder	withBoundingBox(com.tomtom.online.sdk.common.location.BoundingBox boundingBox) The bounding box for the search.
FuzzySearchQueryBuilder	withBrandSet(java.lang.String brandSet) A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.
FuzzySearchQueryBuilder	withCategory(java.lang.Boolean category) If your search use case only requires POI results filtered by category, you may use the Category endpoint.
FuzzySearchQueryBuilder	withCountry(java.lang.String country) A comma-separated string of country codes (e.g., FR,ES).
FuzzySearchQueryBuilder	withEVConnectorSetFilter(java.lang.String EVConnectorSetFilter) A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types.
FuzzySearchQueryBuilder	withExtendedPostalCodes(java.lang.String extendedPostalCodes) Indexes for which extended postal codes should be included in the results.
FuzzySearchQueryBuilder	withGeopoliticalView(java.lang.String geopoliticalView)
FuzzySearchQueryBuilder	withIdx(java.lang.String idx) A comma-separated list of indexes which should be utilized for the search.
FuzzySearchQueryBuilder	withLanguage(java.lang.String language) The language in which search results should be returned.
FuzzySearchQueryBuilder	withLimit(java.lang.Integer limit) The upper limit of the number of results.
FuzzySearchQueryBuilder	withMaxFuzzyLevel(java.lang.Integer maxFuzzyLevel) The maximum fuzzyness level to be used.
FuzzySearchQueryBuilder	withMinFuzzyLevel(java.lang.Integer minFuzzyLevel) The minimum fuzzyness level to be used.
FuzzySearchQueryBuilder	withOffset(java.lang.Integer offset) The starting offset of the returned results within the full result set.
FuzzySearchQueryBuilder	withPosition(LatLng position) The position where results should be biased.
FuzzySearchQueryBuilder	withPreciseness(com.tomtom.online.sdk.common.location.LatLngAcc preciseness) The position where results should be biased.
FuzzySearchQueryBuilder	withTypeAhead(java.lang.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 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

withLimit

public FuzzySearchQueryBuilder withLimit(java.lang.Integer limit)

Description copied from interface: IFuzzySearchQuery

The upper limit of the number of results.

Specified by:

withLimit in interface IFuzzySearchQuery

Parameters:

limit - The upper limit of the number of results.

Returns:

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

withOffset

public FuzzySearchQueryBuilder withOffset(java.lang.Integer offset)

Description copied from interface: IFuzzySearchQuery

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

Specified by:

withOffset in interface IFuzzySearchQuery

Parameters:

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

Returns:

The builder of the query with a new value for the offset being set.

withPosition

public FuzzySearchQueryBuilder withPosition(LatLng position)

Description copied from interface: IFuzzySearchQuery

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 IFuzzySearchQuery

Parameters:

position - The position where results should be biased.

Returns:

The builder of the query with a new value for the position being set.

withPreciseness

public FuzzySearchQueryBuilder withPreciseness(com.tomtom.online.sdk.common.location.LatLngAcc preciseness)

Description copied from interface: IFuzzySearchQuery

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:

withPreciseness in interface IFuzzySearchQuery

Parameters:

preciseness - The position where results should be biased. Position with accuracy is in meters.

Returns:

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

withCountry

public FuzzySearchQueryBuilder withCountry(java.lang.String country)

Description copied from interface: IFuzzySearchQuery

A comma-separated string of country codes (e.g., FR,ES). This will limit the search to the specified countries.

Specified by:

withCountry in interface IFuzzySearchQuery

Returns:

The builder of the query with a new value for the country being set.

withExtendedPostalCodes

public FuzzySearchQueryBuilder withExtendedPostalCodes(java.lang.String extendedPostalCodes)

Description copied from interface: IFuzzySearchQuery

Indexes for which extended postal codes should be included in the results. Available indexes are: Addr, Geo, PAD, POI, Str, XStr. The 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 IFuzzySearchQuery

Parameters:

extendedPostalCodes - The string with postal codes.

Returns:

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

withIdx

public FuzzySearchQueryBuilder withIdx(java.lang.String idx)

Description copied from interface: IFuzzySearchQuery

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 IFuzzySearchQuery

Parameters:

idx - The indexes to be utilized for the search.

Returns:

The builder of the query with a new value for the idxSet being set.

withBoundingBox

public FuzzySearchQueryBuilder withBoundingBox(com.tomtom.online.sdk.common.location.BoundingBox boundingBox)

Description copied from interface: IFuzzySearchQuery

The bounding 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 IFuzzySearchQuery

Parameters:

boundingBox - The top-left position of the bounding box and bottom-right position of the bounding box.

Returns:

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

withTypeAhead

public FuzzySearchQueryBuilder withTypeAhead(java.lang.Boolean typeAhead)

Description copied from interface: IFuzzySearchQuery

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 IFuzzySearchQuery

Parameters:

typeAhead - Determines whether the predictive mode is enabled.

Returns:

The builder of the query with a new value for isTypeAhead being set.

withCategory

public FuzzySearchQueryBuilder withCategory(java.lang.Boolean category)

Description copied from interface: IFuzzySearchQuery

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

Specified by:

withCategory in interface IFuzzySearchQuery

Parameters:

category - Determines whether the Category Search is enabled.

Returns:

The builder of the query with a new value for isCategory being set.

withBrandSet

public FuzzySearchQueryBuilder withBrandSet(java.lang.String brandSet)

Description copied from interface: IFuzzySearchQuery

A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.

Specified by:

withBrandSet in interface IFuzzySearchQuery

Parameters:

brandSet - A comma-separated list of brand names.

Returns:

The builder of the query with a new value for the brand set being set.

withLanguage

public FuzzySearchQueryBuilder withLanguage(java.lang.String language)

Description copied from interface: IFuzzySearchQuery

The language in which search results should be returned. 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 langauge is used.

Specified by:

withLanguage in interface IFuzzySearchQuery

Parameters:

language - The language in which search results should be returned.

Returns:

The builder of the query with a new value for the language being set.

withEVConnectorSetFilter

public FuzzySearchQueryBuilder withEVConnectorSetFilter(java.lang.String EVConnectorSetFilter)

Description copied from interface: IFuzzySearchQuery

A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types.

Specified by:

withEVConnectorSetFilter in interface IFuzzySearchQuery

Parameters:

EVConnectorSetFilter - A comma-separated list of connector types.

Returns:

The builder of the query with a new value for the evConnectorSet.

withMinFuzzyLevel

public FuzzySearchQueryBuilder withMinFuzzyLevel(java.lang.Integer minFuzzyLevel)

Description copied from interface: IFuzzySearchQuery

The minimum fuzzyness level to be used. The default value is 1. The maximum value is 4.

Specified by:

withMinFuzzyLevel in interface IFuzzySearchQuery

Parameters:

minFuzzyLevel - The minimum fuzzyness level to be used.

Returns:

The builder of the query with a new value for the minFuzzyLevel being set.

withMaxFuzzyLevel

public FuzzySearchQueryBuilder withMaxFuzzyLevel(java.lang.Integer maxFuzzyLevel)

Description copied from interface: IFuzzySearchQuery

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

Specified by:

withMaxFuzzyLevel in interface IFuzzySearchQuery

Parameters:

maxFuzzyLevel - The maximum fuzzyness level to be used.

Returns:

The builder of the query with a new value for the maxFuzzyLevel being set.

withGeopoliticalView

public FuzzySearchQueryBuilder withGeopoliticalView(java.lang.String geopoliticalView)

create

public static FuzzySearchQueryBuilder create(java.lang.String term)

Builder used to create an instance of FuzzySearchQuery, once constructed, the user cannot change the field values

Returns:

newly created builder object for FuzzySearchQuery to be used for further processing

build

public FuzzySearchQuery build()

Creates new instance of FuzzySearchQuery