com.tomtom.online.sdk.search.data.autocomplete

Class AutocompleteSearchQueryBuilder

java.lang.Object

com.tomtom.online.sdk.search.data.autocomplete.AutocompleteSearchQueryBuilder

public class AutocompleteSearchQueryBuilder
extends java.lang.Object

Builder class used to create AutocompleteSearchQuery.

Constructor Summary

Constructors

Constructor and Description
AutocompleteSearchQueryBuilder(java.lang.String term, java.lang.String language)

Method Summary

Modifier and Type	Method and Description
AutocompleteSearchQuery	build() Creates a new instance of AutocompleteSearchQuery.
static AutocompleteSearchQueryBuilder	create(java.lang.String term, java.lang.String language) Builder used to create an instance of AutocompleteSearchQuery.
AutocompleteSearchQueryBuilder	withCountry(java.lang.String country) A comma-separated string of country codes (e.g., FR,ES).
AutocompleteSearchQueryBuilder	withLimit(int limit) The maximum number of autocomplete results that will be returned.
AutocompleteSearchQueryBuilder	withPosition(LatLng position) The position where results should be biased.
AutocompleteSearchQueryBuilder	withRadius(int radius) A radius in meters.
AutocompleteSearchQueryBuilder	withResultTypes(java.util.List<ResultType> resultTypes) Restricts the result space based on their segment types (e.g., "category", "brand" or "category,brand").

Methods inherited from class java.lang.Object

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

Constructor Detail

AutocompleteSearchQueryBuilder

public AutocompleteSearchQueryBuilder(java.lang.String term,
                                      java.lang.String language)

Method Detail

withLimit

@NonNull
public AutocompleteSearchQueryBuilder withLimit(int limit)

The maximum number of autocomplete results that will be returned. Default value is 5, maximum value is 10

Parameters:

limit - The maximum number of autocomplete results.

Returns:

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

withPosition

@NonNull
public AutocompleteSearchQueryBuilder withPosition(LatLng position)

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

Parameters:

position - The position where results should be biased.

Returns:

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

withRadius

@NonNull
public AutocompleteSearchQueryBuilder withRadius(int radius)

A radius in meters. It must be used in conjunction with withPosition method. 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:

radius - A radius in meters.

Returns:

The builder of the query with new value for the radius set.

withCountry

@NonNull
public AutocompleteSearchQueryBuilder withCountry(java.lang.String country)

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

Returns:

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

withResultTypes

@NonNull
public AutocompleteSearchQueryBuilder withResultTypes(java.util.List<ResultType> resultTypes)

Restricts the result space based on their segment types (e.g., "category", "brand" or "category,brand"). A result is only included if at least one segment is of any of the indicated types.

Parameters:

resultTypes - A list of segment types which could be used to restrict the result space.

Returns:

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

create

public static AutocompleteSearchQueryBuilder create(java.lang.String term,
                                                    java.lang.String language)

Builder used to create an instance of AutocompleteSearchQuery. Once constructed, the user cannot change the field values.

Parameters:

term - The searched term.

language - Language in which autocomplete results should be returned. Should be one of the TomTom supported IETF language tags.

Returns:

A newly created builder object for AutocompleteSearchQuery to be used for further processing.

build

public AutocompleteSearchQuery build()

Creates a new instance of AutocompleteSearchQuery.