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

Class GeometrySearchQueryBuilder

java.lang.Object

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

All Implemented Interfaces:

IGeometrySearchQuery

public class GeometrySearchQueryBuilder
extends java.lang.Object
implements IGeometrySearchQuery

Builder class used to create GeometrySearchQuery.

Constructor Summary

Constructors

Constructor and Description
GeometrySearchQueryBuilder(java.lang.String term, java.util.List<Geometry> geometries)

Method Summary

Modifier and Type	Method and Description
GeometrySearchQuery	build() Creates new instance of GeometrySearchQuery
static GeometrySearchQueryBuilder	create(java.lang.String term, java.util.List<Geometry> geometries) Builder used to create an instance of GeometrySearchQuery, once constructed, the user cannot change the field values
GeometrySearchQueryBuilder	withExtendedPostalCodesFor(java.lang.String extendedPostalCodesFor) Indexes for which extended postal codes should be included in the results.
GeometrySearchQueryBuilder	withGeopoliticalView(java.lang.String geopoliticalView)
GeometrySearchQueryBuilder	withIdxSet(java.lang.String idxSet) The "idxSet" parameter allows for fine tuning L2 by specifying which indexes to utilize for the search.
GeometrySearchQueryBuilder	withLanguage(java.lang.String language) Language in which search results should be returned.
GeometrySearchQueryBuilder	withLimit(java.lang.Integer limit) Maximum number of responses that will be returned.
GeometrySearchQueryBuilder	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

GeometrySearchQueryBuilder

public GeometrySearchQueryBuilder(java.lang.String term,
                                  java.util.List<Geometry> geometries)

Method Detail

withLanguage

public GeometrySearchQueryBuilder withLanguage(java.lang.String language)

Description copied from interface: IGeometrySearchQuery

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 IGeometrySearchQuery

Parameters:

language - language in which search results should be returned.

Returns:

the builder of the GeometrySearchQuery with new value for language set.

withLimit

public GeometrySearchQueryBuilder withLimit(java.lang.Integer limit)

Description copied from interface: IGeometrySearchQuery

Maximum number of responses that will be returned.

Specified by:

withLimit in interface IGeometrySearchQuery

Parameters:

limit - maximum number of responses that will be returned.

Returns:

the builder of the GeometrySearchQuery with new value for limit set.

withTypeAhead

public GeometrySearchQueryBuilder withTypeAhead(java.lang.Boolean typeAhead)

Description copied from interface: IGeometrySearchQuery

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

Specified by:

withTypeAhead in interface IGeometrySearchQuery

Parameters:

typeAhead - predictive mode.

Returns:

the builder of the GeometrySearchQuery with new value for typeahead set.

withExtendedPostalCodesFor

public GeometrySearchQueryBuilder withExtendedPostalCodesFor(java.lang.String extendedPostalCodesFor)

Description copied from interface: IGeometrySearchQuery

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

Specified by:

withExtendedPostalCodesFor in interface IGeometrySearchQuery

Parameters:

extendedPostalCodesFor - indexes for which extended postal codes should be included in the results.

Returns:

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

withIdxSet

public GeometrySearchQueryBuilder withIdxSet(java.lang.String idxSet)

Description copied from interface: IGeometrySearchQuery

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

Specified by:

withIdxSet in interface IGeometrySearchQuery

Parameters:

idxSet - indexes to utilize for the search.

Returns:

the builder of the GeometrySearchQuery with new value for idxSet set.

withGeopoliticalView

public GeometrySearchQueryBuilder withGeopoliticalView(java.lang.String geopoliticalView)

create

public static GeometrySearchQueryBuilder create(java.lang.String term,
                                                java.util.List<Geometry> geometries)

Builder used to create an instance of GeometrySearchQuery, once constructed, the user cannot change the field values

Returns:

newly created builder object for GeometrySearchQuery to be used for further processing

build

public GeometrySearchQuery build()

Creates new instance of GeometrySearchQuery