com.tomtom.online.sdk.search.data

Class SearchQuery

java.lang.Object

com.tomtom.online.sdk.search.data.SearchQuery

All Implemented Interfaces:

android.os.Parcelable

public class SearchQuery
extends java.lang.Object
implements android.os.Parcelable

SearchQuery is used to transfer SearchAPI parameters in a readable manner. This class can be written to and restored from an Android Parcel class. The SearchQuery instance can be constructed only using the associated builder class. Once constructed, the user cannot change the field values.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<SearchQuery>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
static SearchQueryBuilder	builder() Instantiates the SearchQueryBuilder object.
protected boolean	canEqual(java.lang.Object other)
int	describeContents()
boolean	equals(java.lang.Object o)
LatLng	getBottomRight() Bottom right location of the bounding box.
Category	getCategory() Search for a specific category.
java.lang.String	getCountry() This will limit the search to the specified countries.
java.lang.String	getIdxSet() Specifying which indexes to utilize for the search.
java.lang.String	getLanguage() Language in which search results should be returned.
java.lang.Integer	getLimit() Maximum number of search results which will be returned by the search service.
LatLng	getLocation() Position where results should be biased.
java.lang.Integer	getMaxFuzzyLevel() Maximum fuzziness level to be used.
java.lang.Integer	getMinFuzzyLevel() Minimum fuzziness level to be used.
java.lang.Integer	getOffset() Starting offset of the returned results within the full result set.
java.lang.Integer	getRadius() If radius and location are set, the results will be constrained to the defined area.
java.lang.String	getTerm() Query to be searched.
LatLng	getTopLeft() Top left location of the bounding box.
int	hashCode()
boolean	isCategory() Checks whether provided query is for category or not.
boolean	isTypeAhead() If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<SearchQuery> CREATOR

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

builder

public static SearchQueryBuilder builder()

Instantiates the SearchQueryBuilder object.

Returns:

newly created SearchQueryBuilder object.

getLimit

public java.lang.Integer getLimit()

Maximum number of search results which will be returned by the search service.

Returns:

Value between 0 and 100, default is 10.

getOffset

public java.lang.Integer getOffset()

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

Returns:

Value between 0 and 1900, default is 0.

getRadius

public java.lang.Integer getRadius()

If radius and location are set, the results will be constrained to the defined area.

Returns:

Value in meters, no default value.

getLocation

public LatLng getLocation()

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

Returns:

A pair of decimal values which represents a geo location (latitude, longitude).

getTopLeft

public LatLng getTopLeft()

Top left location of the bounding box.

getBottomRight

public LatLng getBottomRight()

Bottom right location of the bounding box.

getTerm

@NonNull
public java.lang.String getTerm()

Query to be searched. It cannot be null.

Returns:

Not null term value.

getCountry

public java.lang.String getCountry()

This will limit the search to the specified countries.

Returns:

2 or 3 letter country code (e.g.: FR, ES).

getIdxSet

public java.lang.String getIdxSet()

Specifying which indexes to utilize for the search. The predefined indexes are: Addr (address range interpolation), Geo (Geographies), Str (streets). Example: idxSet=POI, idxSet=PAD.

getLanguage

public java.lang.String getLanguage()

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 language is used.

isTypeAhead

public boolean isTypeAhead()

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

Returns:

boolean value which represents the activation of search input predictive mode, default is 'false'.

isCategory

public boolean isCategory()

Checks whether provided query is for category or not.

getCategory

public Category getCategory()

Search for a specific category.

getMinFuzzyLevel

public java.lang.Integer getMinFuzzyLevel()

Minimum fuzziness level to be used.

Returns:

Integer value between 1 and 4.

getMaxFuzzyLevel

public java.lang.Integer getMaxFuzzyLevel()

Maximum fuzziness level to be used.

Returns:

Integer value between 3 and 4.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object