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

Class GeometrySearchQueryBuilder

java.lang.Object

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

All Implemented Interfaces:

GeometrySearchQuery

public class GeometrySearchQueryBuilder
extends java.lang.Object
implements 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
void	dispose() Disposes the GeometrySearchQuery object which was constructed at native layer
long	getNativeHandle() Handle of native pointer address
GeometrySearchQuery	withExtendedPostalCodesFor(java.lang.String extendedPostalCodesFor) Indexes for which extended postal codes should be included in the results.
GeometrySearchQuery	withIdxSet(java.lang.String idxSet) The "idxSet" parameter allows for fine tuning L2 by specifying which indexes to utilize for the search.
GeometrySearchQuery	withLanguage(java.lang.String language) Language in which search results should be returned.
GeometrySearchQuery	withLimit(int limit) Maximum number of responses that will be returned.
GeometrySearchQuery	withTypeAhead(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)
                           throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

Method Detail

getNativeHandle

public long getNativeHandle()

Description copied from interface: GeometrySearchQuery

Handle of native pointer address

Specified by:

getNativeHandle in interface GeometrySearchQuery

Returns:

long value which represents the native handler

dispose

public void dispose()

Description copied from interface: GeometrySearchQuery

Disposes the GeometrySearchQuery object which was constructed at native layer

Specified by:

dispose in interface GeometrySearchQuery

withLimit

public GeometrySearchQuery withLimit(int limit)

Description copied from interface: GeometrySearchQuery

Maximum number of responses that will be returned.

Specified by:

withLimit in interface GeometrySearchQuery

Parameters:

limit - maximum number of responses that will be returned.

Returns:

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

withTypeAhead

public GeometrySearchQuery withTypeAhead(boolean typeahead)

Description copied from interface: GeometrySearchQuery

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 GeometrySearchQuery

Parameters:

typeahead - predictive mode.

Returns:

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

withLanguage

public GeometrySearchQuery withLanguage(java.lang.String language)

Description copied from interface: GeometrySearchQuery

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 GeometrySearchQuery

Parameters:

language - language in which search results should be returned.

Returns:

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

withExtendedPostalCodesFor

public GeometrySearchQuery withExtendedPostalCodesFor(java.lang.String extendedPostalCodesFor)

Description copied from interface: GeometrySearchQuery

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 GeometrySearchQuery

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 GeometrySearchQuery withIdxSet(java.lang.String idxSet)

Description copied from interface: GeometrySearchQuery

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 GeometrySearchQuery

Parameters:

idxSet - indexes to utilize for the search.

Returns:

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