FuzzySearchQueryBuilder (Android Search SDK

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)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`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)` Comma separated string of country codes (eg: FR,ES).
`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)` 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)` Maximum fuzzyness level to be used.
`FuzzySearchQueryBuilder`	`withMinFuzzyLevel(java.lang.Integer minFuzzyLevel)` Minimum fuzzyness level to be used.
`FuzzySearchQueryBuilder`	`withOffset(java.lang.Integer offset)` 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 - upper limit of the number of results.
    
    Returns:
    
    the builder of the query with new value for limit set.
  - withOffset
```
public FuzzySearchQueryBuilder withOffset(java.lang.Integer offset)
```
    Description copied from interface: IFuzzySearchQuery
    
    Starting offset of the returned results within the full result set.
    
    Specified by:
    
    withOffset in interface IFuzzySearchQuery
    
    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 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 - position where results should be biased.
    
    Returns:
    
    the builder of the query with new value for position 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 - position where results should be biased. Position with accuracy in m.
    
    Returns:
    
    the builder of the query with new values for position and radius set.
  - withCountry
```
public FuzzySearchQueryBuilder withCountry(java.lang.String country)
```
    Description copied from interface: IFuzzySearchQuery
    
    Comma separated string of country codes (eg: FR,ES). This will limit the search to the specified countries.
    
    Specified by:
    
    withCountry in interface IFuzzySearchQuery
    
    Parameters:
    
    country - string with country codes.
    
    Returns:
    
    the builder of the query with new value for country 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. 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 - string with postal codes.
    
    Returns:
    
    the builder of the query with 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 - indexes to be utilized for the search.
    
    Returns:
    
    the builder of the query with new value for idxSet 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 - top left position of the bounding box and bottom right position of the bounding box.
    
    Returns:
    
    the builder of the query with new value for bounding box 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 - whether the predictive mode is enabled.
    
    Returns:
    
    the builder of the query with new value for isTypeAhead 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 - whether the category search is enabled.
    
    Returns:
    
    the builder of the query with new value for isCategory set.
  - withLanguage
```
public FuzzySearchQueryBuilder withLanguage(java.lang.String language)
```
    Description copied from interface: IFuzzySearchQuery
    
    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 IFuzzySearchQuery
    
    Parameters:
    
    language - language in which search results should be returned.
    
    Returns:
    
    the builder of the query with new value for language set.
  - withMinFuzzyLevel
```
public FuzzySearchQueryBuilder withMinFuzzyLevel(java.lang.Integer minFuzzyLevel)
```
    Description copied from interface: IFuzzySearchQuery
    
    Minimum fuzzyness level to be used. The default value is 1, the maximum value is 4.
    
    Specified by:
    
    withMinFuzzyLevel in interface IFuzzySearchQuery
    
    Parameters:
    
    minFuzzyLevel - minimum fuzzyness level to be used.
    
    Returns:
    
    the builder of the query with new value for minFuzzyLevel set.
  - withMaxFuzzyLevel
```
public FuzzySearchQueryBuilder withMaxFuzzyLevel(java.lang.Integer maxFuzzyLevel)
```
    Description copied from interface: IFuzzySearchQuery
    
    Maximum fuzzyness level to be used. The default value is 2, the maximum value is 4.
    
    Specified by:
    
    withMaxFuzzyLevel in interface IFuzzySearchQuery
    
    Parameters:
    
    maxFuzzyLevel - maximum fuzzyness level to be used.
    
    Returns:
    
    the builder of the query with new value for maxFuzzyLevel 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

Class FuzzySearchQueryBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FuzzySearchQueryBuilder

Method Detail

withLimit

withOffset

withPosition

withPreciseness

withCountry

withExtendedPostalCodes

withIdx

withBoundingBox

withTypeAhead

withCategory

withLanguage

withMinFuzzyLevel

withMaxFuzzyLevel

withGeopoliticalView

create

build