com.tomtom.online.sdk.search.data

Class SearchResult

java.lang.Object

com.tomtom.online.sdk.search.data.SearchResult

All Implemented Interfaces:

java.io.Serializable

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

SearchResult represents a single search result item. The obtained values are accessible only through getter methods. It is not possible to modify the constructed values.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static SearchResultBuilder	builder() Instantiates the SearchResultBuilder object.
java.lang.String	getAddressLine1() First address line, usually street name with number.
java.lang.String	getAddressLine2() Second address line, usually country, city name nad postal code if available for obtained result.
java.lang.String[]	getCategories() List of categories associated with obtained result.
java.lang.String	getCountryCode() Country code associated with obtained result.
java.lang.String	getGeoHash() Geohash generated from latitude and longitude, unique for each item.
java.lang.String	getIdentifier() Result identifier, unique per each item.
LatLng	getLocation() Position (latitude, longitude).
java.lang.String	getName() POI name if available, otherwise empty string.
java.lang.String	getPhoneNumber() Phone number if available, otherwise empty string.
java.lang.String	getType() Type of a result.
java.lang.String	getUrl() POI url if available, otherwise empty string.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SearchResultBuilder builder()

Instantiates the SearchResultBuilder object.

Returns:

newly created SearchResultBuilder object.

getIdentifier

@NonNull
public java.lang.String getIdentifier()

Result identifier, unique per each item.

getType

public java.lang.String getType()

Type of a result. May be one of these: POI, Street, Geography, PointAddress.

getCategories

public java.lang.String[] getCategories()

List of categories associated with obtained result.

Returns:

The list of categories is not empty only if the obtained result is of type POI.

getAddressLine1

public java.lang.String getAddressLine1()

First address line, usually street name with number.

Returns:

The street name with number.

getAddressLine2

public java.lang.String getAddressLine2()

Second address line, usually country, city name nad postal code if available for obtained result.

Returns:

The country, city name and postal code.

getName

public java.lang.String getName()

POI name if available, otherwise empty string.

getPhoneNumber

public java.lang.String getPhoneNumber()

Phone number if available, otherwise empty string.

getCountryCode

public java.lang.String getCountryCode()

Country code associated with obtained result.

getLocation

public LatLng getLocation()

Position (latitude, longitude).

getGeoHash

public java.lang.String getGeoHash()

Geohash generated from latitude and longitude, unique for each item. May be used as a key to distinguish between various results.

getUrl

public java.lang.String getUrl()

POI url if available, otherwise empty string.