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

Class GeometrySearchQuery

java.lang.Object

com.tomtom.online.sdk.common.jni.BaseRequestQuery

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

All Implemented Interfaces:

com.tomtom.online.sdk.common.jni.JniDataModel, com.tomtom.online.sdk.common.jni.JniNativeHandleOwner, com.tomtom.online.sdk.common.jni.NativeObject

public class GeometrySearchQuery
extends com.tomtom.online.sdk.common.jni.BaseRequestQuery

A builder Class used to create GeometrySearchQuery.

Field Summary

Fields inherited from interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

EMPTY_HANDLE

Constructor Summary

Constructors

Constructor and Description

GeometrySearchQuery(java.lang.String term, java.util.List<Geometry> geometries, java.lang.String language, java.lang.Integer limit, java.lang.Boolean typeAhead, java.lang.String extendedPostalCodesFor, java.lang.String idxSet, java.lang.String geopoliticalView, java.util.Set<MapCodeType> mapCodes, OpeningHoursMode openingHours, TimeZoneType timeZone) Creates instance of a geometry search query and initializes proper fields with defined parameters.

Method Summary

Modifier and Type	Method and Description
void	dispose()
long	getNativeHandle()
long	prepare()

Methods inherited from class com.tomtom.online.sdk.common.jni.BaseRequestQuery

isAutoDisposable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeometrySearchQuery

public GeometrySearchQuery(java.lang.String term,
                           java.util.List<Geometry> geometries,
                           java.lang.String language,
                           java.lang.Integer limit,
                           java.lang.Boolean typeAhead,
                           java.lang.String extendedPostalCodesFor,
                           java.lang.String idxSet,
                           java.lang.String geopoliticalView,
                           java.util.Set<MapCodeType> mapCodes,
                           OpeningHoursMode openingHours,
                           TimeZoneType timeZone)

Creates instance of a geometry search query and initializes proper fields with defined parameters.

Parameters:

term - The searched phrase.

geometries - The list of Geometry objects that can be either a polygon or circle geometry.

language - The language in which the search results should be returned. It should be one of the supported IETF language tags, case insensitive.

limit - The maximum limit of Responses that will be returned.

typeAhead - If true, then the query will be interpreted as a partial input, and the search will enter predictive mode.

extendedPostalCodesFor - The indexes for extended postal codes that should be included in the results. Available indexes are: Addr, Geo, PAD, POI, Str, XStr.

idxSet - The indexes to utilize for the search.

geopoliticalView - This defines what kind of geopolitical view should be used.

openingHours - The opening hours scope.

mapCodes - The enum type indicating supported MapCodes.

timeZone - Used to indicate the mode in which the timeZone object should be returned.

Method Detail

prepare

public long prepare()

Specified by:

prepare in interface com.tomtom.online.sdk.common.jni.JniDataModel

Overrides:

prepare in class com.tomtom.online.sdk.common.jni.BaseRequestQuery

getNativeHandle

public long getNativeHandle()

dispose

public void dispose()