com.tomtom.online.sdk.search.data.geometry

Interface IGeometrySearchQuery

public interface IGeometrySearchQuery

An Interface that specifies the parameters of a geometry search query, such as a responses limit or language in which the search results should be returned.

Method Summary

Modifier and Type	Method and Description
IGeometrySearchQuery	withExtendedPostalCodesFor(java.lang.String extendedPostalCodesFor) Indexes for extended postal codes that should be included in the results.
IGeometrySearchQuery	withIdxSet(java.lang.String idxSet) The "idxSet" parameter allows for fine tuning L2 by specifying which indexes to utilize for the search.
IGeometrySearchQuery	withLanguage(java.lang.String language) The language in which search results should be returned.
IGeometrySearchQuery	withLimit(java.lang.Integer limit) The maximum number of responses that will be returned.
IGeometrySearchQuery	withMapCodes(java.util.Set<MapCodeType> mapCodes) Enables the return of mapcodes.
IGeometrySearchQuery	withOpeningHours(OpeningHoursMode openingHours) When used includes a list of opening hours for a POI (Points of Interest).
IGeometrySearchQuery	withTimeZone(TimeZoneType timeZone) When used includes POIs' time zones.
IGeometrySearchQuery	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.

Method Detail

withLimit

@NonNull
IGeometrySearchQuery withLimit(java.lang.Integer limit)

The maximum number of responses that will be returned.

Parameters:

limit - The maximum number of responses that will be returned.

Returns:

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

withTypeAhead

@NonNull
IGeometrySearchQuery 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. Default value: false

Parameters:

typeahead - The predictive mode.

Returns:

The builder of the GeometrySearchQuery with a new value for typeahead being set.

withLanguage

@NonNull
IGeometrySearchQuery withLanguage(java.lang.String language)

The language in which search results should be returned. It should be one of the supported IETF language tags, case insensitive. When data in the specified language is not available for a specific field, the default langauge is used.

Parameters:

language - The language in which search results should be returned.

Returns:

The builder of the GeometrySearchQuery with a new value for the language being set.

withExtendedPostalCodesFor

@NonNull
IGeometrySearchQuery withExtendedPostalCodesFor(java.lang.String extendedPostalCodesFor)

Indexes for extended postal codes that should be included in the results. Available indexes are: Addr, Geo, PAD, POI, Str, XStr. For example: extendedPostalCodesFor=PAD,Addr,POI Availability is region-dependent.

Parameters:

extendedPostalCodesFor - Indexes for extended postal codes that should be included in the results.

Returns:

The builder of the GeometrySearchQuery with new value for extendedPostalCodesFor set.

withIdxSet

@NonNull
IGeometrySearchQuery withIdxSet(java.lang.String idxSet)

The "idxSet" parameter allows for fine tuning L2 by specifying which indexes to utilize for the search. Comma-separated, for example: idxSet=POI,PAD,Str,Xstr,Geo,Addr

Parameters:

idxSet - Indexes to utilize for the search.

Returns:

The builder of the GeometrySearchQuery with a new value for the idxSet being set.

withOpeningHours

@NonNull
IGeometrySearchQuery withOpeningHours(OpeningHoursMode openingHours)

When used includes a list of opening hours for a POI (Points of Interest).

Parameters:

openingHours - The opening hours scope.

Returns:

A reference to the builder object.

withMapCodes

@NonNull
IGeometrySearchQuery withMapCodes(java.util.Set<MapCodeType> mapCodes)

Enables the return of mapcodes.

Parameters:

mapCodes - The enum type indicating supported MapCodes.

Returns:

A reference to the builder object.

withTimeZone

@NonNull
IGeometrySearchQuery withTimeZone(TimeZoneType timeZone)

When used includes POIs' time zones.

Parameters:

timeZone - The enum indicating the type of the time zone.

Returns:

A reference to the builder object.