sdk-search / com.tomtom.online.sdk.search.data.geometry / GeometrySearchResult

GeometrySearchResult

open class GeometrySearchResult : Serializable

The result of a Geometry Search query.

Constructors

<init>

GeometrySearchResult()

The result of a Geometry Search query.

Properties

additionalDataSources

var additionalDataSources: AdditionalDataSources!

Information about sources of additional data that can be used with the Additional Data service.

address

var address: Address!

This object contains the address information of a result. Fields availability vary depending on an administrative hierarchy of a result's country of origin and a result itself (e.g., if a result represents a country that does not have subdivision information).

addressRanges

var addressRanges: AddressRanges!

Address ranges on a street segment. Available only for results where the result type is equal to "Address Range".

boundingBox

var boundingBox: BoundingBox!

A rectangle into which the shape of an administrative area is inscribed. Available only for results where the result type is equal to "Geography", and municipality information is not present.

distance

var distance: Double

The distance in meters from the provided starting point for a search. It is available in a response only when the request contains "lat" and "lon" parameters.

entityType

var entityType: String!

(Only for results of type "Geography") The type of the entity. (One of "County", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTeritarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighborhood", "PostalCodeArea").

entryPoints

var entryPoints: Array<EntryPoint!>!

(Only for POI) Points of entry to the POI.

id

var id: String!

The ID of the return result. It is not guaranteed to be stable. On the contrary, it may often change.

info

var info: String!

Information about the original data source of the result.

mapCodes

var mapCodes: Array<MapCode!>!

A list of MapCode objects.

poi

var poi: Poi!

This section is available when the type of the result is equal to "POI" (Points of Interest). It contains the basic properties of a POI.

position

var position: LatLng!

A point representing the geographical center of a result or an address point if a result contains full address information (including a house number).

relatedPois

var relatedPois: Array<RelatedPoi!>!

A list of RelatedPoi objects.

score

var score: Double

The score of the result. A larger score means that the probability of a result meets a higher query criteria.

type

var type: String!

The type of result. Allowed values: "Street", "Point Address", "Geography", "POI", "Cross Street", "Address Range".

viewport

var viewport: BoundingBox!

A viewport which can be used to display the entity on a map.

Functions

getAdditionalDataSources

open fun getAdditionalDataSources(): AdditionalDataSources!

Returns information about sources of additional data that can be used with the Additional Data service.

getAddress

open fun getAddress(): Address!

Returns the object containing the address information of a result. Fields availability vary depending on an administrative hierarchy of a result's country of origin and a result itself (e.g., if a result represents a country that does not have subdivision information).

getAddressRanges

open fun getAddressRanges(): AddressRanges!

Returns the address ranges on a street segment. Available only for results where the result type is equal to "Address Range".

getBoundingBox

open fun getBoundingBox(): BoundingBox!

Returns a rectangle into which the shape of an administrative area is inscribed. Available only for results where the result type is equal to "Geography", and municipality information is not present.

getDistance

open fun getDistance(): Double

Returns the distance in meters from the provided starting point for a search. It is available in a response only when the request contains "lat" and "lon" parameters.

getEntityType

open fun getEntityType(): String!

Returns the type of entity.

getEntryPoints

open fun getEntryPoints(): ImmutableList<EntryPoint!>!

getId

open fun getId(): String!

Returns the ID of the return result. It is not guaranteed to be stable. On the contrary, it may often change.

getInfo

open fun getInfo(): String!

Returns the information about the original data source of the result.

getMapCodes

open fun getMapCodes(): ImmutableList<MapCode!>!

getPoi

open fun getPoi(): Poi!

Returns the POI if this section is available when the type of the result is equal to "POI" (Points of Interest). It contains the basic properties of a POI.

getPosition

open fun getPosition(): LatLng!

Returns a point representing the geographical center of a result or an address point if a result contains full address information (including a house number).

getRelatedPois

open fun getRelatedPois(): ImmutableList<RelatedPoi!>!

getScore

open fun getScore(): Double

Returns the score of the result. A larger score means that the probability of a result meets a higher query criteria.

getType

open fun getType(): String!

Returns the type of result. Allowed values: "Street", "Point Address", "Geography", "POI", "Cross Street", "Address Range".

getViewport

open fun getViewport(): BoundingBox!

Returns a viewport which can be used to display the entity on a map.

toString

open fun toString(): String