com.inrix.sdk

Class SearchManager.AutocompleteSearchOptions

java.lang.Object

com.inrix.sdk.SearchManager.AutocompleteSearchOptions

Enclosing class:

SearchManager

public static class SearchManager.AutocompleteSearchOptions
extends Object

Represents options for autocomplete search.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RADIUS The default search radius in meters.
static int	MAXIMUM_RADIUS The maximum allowed search radius in meters.
static int	MINIMUM_QUERY_CHARACTERS The minimum allowed characters for performing an autocomplete query.

Constructor Summary

Constructors

Constructor and Description
AutocompleteSearchOptions(String searchQuery, GeoPoint centerPoint) Constructor for an autocomplete search.

Method Summary

Methods

Modifier and Type	Method and Description
T	setCenterPoint(GeoPoint point) Set the center point that the search should be originated from.
SearchManager.AutocompleteSearchOptions	setQuery(String searchQuery) Set the search query.
T	setRadius(int radiusMeters) Set the preferred search radius in meters from the center point.
T	setResultsLocale(Locale locale) Set the preferred locale for the language of the results.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MINIMUM_QUERY_CHARACTERS

public static final int MINIMUM_QUERY_CHARACTERS

The minimum allowed characters for performing an autocomplete query.

See Also:

SearchManager.AutocompleteSearchOptions.setQuery(String), Constant Field Values

DEFAULT_RADIUS

public static final int DEFAULT_RADIUS

The default search radius in meters.

See Also:

setRadius(int), Constant Field Values

MAXIMUM_RADIUS

public static final int MAXIMUM_RADIUS

The maximum allowed search radius in meters.

See Also:

setRadius(int), Constant Field Values

Constructor Detail

AutocompleteSearchOptions

public AutocompleteSearchOptions(String searchQuery,
                         GeoPoint centerPoint)

Constructor for an autocomplete search.

Parameters:

searchQuery - The search query string.

centerPoint - The search center point.

See Also:

SearchManager.AutocompleteSearchOptions.setQuery(String), setCenterPoint(GeoPoint)

Method Detail

setQuery

public SearchManager.AutocompleteSearchOptions setQuery(String searchQuery)

Set the search query.

Parameters:

searchQuery - The search text.

Returns:

The current instance.

Throws:

SearchManager.SearchManagerException - when the input is null or does is does not meet the minimum character length defined by SearchManager.AutocompleteSearchOptions.MINIMUM_QUERY_CHARACTERS.

setCenterPoint

public T setCenterPoint(GeoPoint point)

Set the center point that the search should be originated from.

Parameters:

point - The search center point.

Returns:

The current instance.

Throws:

SearchManager.SearchManagerException - when the input is invalid.

setRadius

public T setRadius(int radiusMeters)

Set the preferred search radius in meters from the center point. This value is used to place a higher weight on results contained within the radius; however, prominent results from outside of the radius could still be returned.

Parameters:

radiusMeters - The radius in meters.

Returns:

The current instance.

Throws:

SearchManager.SearchManagerException - when the input is invalid.

See Also:

MAXIMUM_RADIUS, DEFAULT_RADIUS

toString

public String toString()

Overrides:

toString in class Object

setResultsLocale

public T setResultsLocale(Locale locale)

Set the preferred locale for the language of the results.

Parameters:

locale - The locale or null to use the default;

Returns:

The current instance.