com.algolia.search.saas.places

Class PlacesQuery

Object

com.algolia.search.saas.AbstractQuery

com.algolia.search.saas.places.PlacesQuery

public class PlacesQuery
extends AbstractQuery

Search parameters for Algolia Places.

See Also:

PlacesClient.searchAsync(PlacesQuery, CompletionHandler)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlacesQuery.Type Types of places that can be searched for.

Nested classes/interfaces inherited from class com.algolia.search.saas.AbstractQuery

AbstractQuery.LatLng

Field Summary

Fields

Modifier and Type	Field and Description
static int	RADIUS_ALL

Constructor Summary

Constructors

Constructor and Description
PlacesQuery() Construct an empty query.
PlacesQuery(CharSequence query) Construct a query with the specified full text query.
PlacesQuery(PlacesQuery other) Clone an existing query.

Method Summary

Modifier and Type	Method and Description
AbstractQuery.LatLng	getAroundLatLng()
Boolean	getAroundLatLngViaIP()
Integer	getAroundRadius() Get the current radius for around latitude/longitude queries.
String[]	getCountries()
String	getHighlightPostTag()
String	getHighlightPreTag()
Integer	getHitsPerPage()
String	getLanguage()
String	getQuery()
PlacesQuery.Type	getType()
PlacesQuery	set(String name, Object value) Set a parameter in an untyped fashion.
PlacesQuery	setAroundLatLng(AbstractQuery.LatLng location) Force to *first* search around a specific latitude/longitude.
PlacesQuery	setAroundLatLngViaIP(Boolean enabled) Search *first* around the geolocation of the user found via his IP address.
PlacesQuery	setAroundRadius(Integer radius) Change the radius for around latitude/longitude queries.
PlacesQuery	setCountries(String... countries) Restrict the search results to a specific list of countries.
PlacesQuery	setHighlightPostTag(String tag)
PlacesQuery	setHighlightPreTag(String tag)
PlacesQuery	setHitsPerPage(Integer nbHitsPerPage) Set how many results you want to retrieve per search.
PlacesQuery	setLanguage(String language) Restrict the search results to a single language.
PlacesQuery	setQuery(CharSequence query) Set the full text query.
PlacesQuery	setType(PlacesQuery.Type type) Set the type of place to search for.

Methods inherited from class com.algolia.search.saas.AbstractQuery

build, equals, get, hashCode, parseFrom, parseLatLng, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

RADIUS_ALL

public static final int RADIUS_ALL

See Also:

Constant Field Values

Constructor Detail

PlacesQuery

public PlacesQuery()

Construct an empty query.

PlacesQuery

public PlacesQuery(CharSequence query)

Construct a query with the specified full text query.

Parameters:

query - Full text query.

PlacesQuery

public PlacesQuery(@NonNull
                   PlacesQuery other)

Clone an existing query.

Parameters:

other - The query to be cloned.

Method Detail

setQuery

@NonNull
public PlacesQuery setQuery(CharSequence query)

Set the full text query.

getQuery

public String getQuery()

setAroundLatLng

@NonNull
public PlacesQuery setAroundLatLng(AbstractQuery.LatLng location)

Force to *first* search around a specific latitude/longitude. The default is to search around the location of the user determined via his IP address (geoip).

Parameters:

location - The location to start the search at, or `null` to use the default.

getAroundLatLng

public AbstractQuery.LatLng getAroundLatLng()

setAroundLatLngViaIP

@NonNull
public PlacesQuery setAroundLatLngViaIP(Boolean enabled)

Search *first* around the geolocation of the user found via his IP address. Default: `true`.

Parameters:

enabled - Whether to use IP address to determine geolocation, or `null` to use the default.

getAroundLatLngViaIP

public Boolean getAroundLatLngViaIP()

setAroundRadius

@NonNull
public PlacesQuery setAroundRadius(Integer radius)

Change the radius for around latitude/longitude queries.

Parameters:

radius - The radius to set, or RADIUS_ALL to disable stopping at a specific radius, or `null` to use the default.

getAroundRadius

public Integer getAroundRadius()

Get the current radius for around latitude/longitude queries.

Returns:

Query.RADIUS_ALL if set to 'all'.

setHighlightPostTag

@NonNull
public PlacesQuery setHighlightPostTag(String tag)

getHighlightPostTag

public String getHighlightPostTag()

setHighlightPreTag

@NonNull
public PlacesQuery setHighlightPreTag(String tag)

getHighlightPreTag

public String getHighlightPreTag()

setHitsPerPage

@NonNull
public PlacesQuery setHitsPerPage(Integer nbHitsPerPage)

Set how many results you want to retrieve per search. Default: 20.

getHitsPerPage

public Integer getHitsPerPage()

setType

@NonNull
public PlacesQuery setType(PlacesQuery.Type type)

Set the type of place to search for.

Parameters:

type - Type of place to search for.

getType

public PlacesQuery.Type getType()

setLanguage

@NonNull
public PlacesQuery setLanguage(String language)

Restrict the search results to a single language. You can pass two letters country codes (ISO 639-1).

Parameters:

language - The language used to return the results, or `null` to use all available languages.

Returns:

This query.

getLanguage

public String getLanguage()

setCountries

@NonNull
public PlacesQuery setCountries(String... countries)

Restrict the search results to a specific list of countries. You can pass two letters country codes (ISO 3166-1).

Default: Search on the whole planet.

Parameters:

countries - The countries to restrict the search to, or `null` to search on the whole planet.

Returns:

This query.

getCountries

public String[] getCountries()

set

@NonNull
public PlacesQuery set(@NonNull
                                String name,
                                @Nullable
                                Object value)

Set a parameter in an untyped fashion. This low-level accessor is intended to access parameters that this client does not yet support.

Overrides:

set in class AbstractQuery

Parameters:

name - The parameter's name.

value - The parameter's value, or null to remove it. It will first be converted to a String by the `toString()` method.

Returns:

This instance (used to chain calls).