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

Class GeometrySearchResult

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

public class GeometrySearchResult
extends java.lang.Object
implements java.io.Serializable

The result of a Geometry Search query.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AdditionalDataSources	additionalDataSources Information about sources of additional data that can be used with the Additional Data service.
protected Address	address This object contains the address information of a result.
protected AddressRanges	addressRanges Address ranges on a street segment.
protected com.tomtom.online.sdk.common.location.BoundingBox	boundingBox A rectangle into which the shape of an administrative area is inscribed.
protected double	distance The distance in meters from the provided starting point for a search.
protected java.lang.String	entityType (Only for results of type "Geography") The type of the entity.
protected EntryPoint[]	entryPoints (Only for POI) Points of entry to the POI.
protected java.lang.String	id The ID of the return result.
protected java.lang.String	info Information about the original data source of the result.
protected Poi	poi This section is available when the type of the result is equal to "POI" (Points of Interest).
protected LatLng	position A point representing the geographical center of a result or an address point if a result contains full address information (including a house number).
protected double	score The score of the result.
protected java.lang.String	type The type of result.
protected com.tomtom.online.sdk.common.location.BoundingBox	viewport A viewport which can be used to display the entity on a map.

Constructor Summary

Constructors

Constructor and Description
GeometrySearchResult()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.String id

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

type

protected java.lang.String type

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

score

protected double score

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

distance

protected double distance

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. -- GETTER --

info

protected java.lang.String info

Information about the original data source of the result. -- GETTER --

entityType

protected java.lang.String entityType

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

poi

protected 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. -- GETTER --

address

protected 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). -- GETTER --

position

protected LatLng position

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

viewport

protected com.tomtom.online.sdk.common.location.BoundingBox viewport

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

boundingBox

protected com.tomtom.online.sdk.common.location.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. -- GETTER --

entryPoints

protected EntryPoint[] entryPoints

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

addressRanges

protected AddressRanges addressRanges

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

additionalDataSources

protected AdditionalDataSources additionalDataSources

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

Constructor Detail

GeometrySearchResult

public GeometrySearchResult()