com.here.android.mpa.search

Class GeocodeResult

java.lang.Object

com.here.android.mpa.search.GeocodeResult

public class GeocodeResult
extends java.lang.Object

Represents the result of a geocode request. The data of a geocode result is represented by an instance of Location, accessed through the location property. The quality of the result can be assessed in a broad sense with the relevance property, or in more detail using the matchQuality dictionary.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Location	getLocation() The location data of the geocode result.
java.lang.String	getMatchLevel() Shows the level of the most precise area information for the match, district, city or a higher administrative level.
java.util.Map<java.lang.String,java.lang.Float>	getMatchQuality() Details about the quality of the result.
float	getRelevance() The relevance of the result location to the original search parameters.
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Detail

getRelevance

public float getRelevance()

The relevance of the result location to the original search parameters. The relevance of a result provides a measure of how accurate or reliable it is. The valid range is [0, 1], with a value of 1 representing a perfect match.

Returns:

The relevance of the result location to the original search parameters.

getMatchLevel

public java.lang.String getMatchLevel()

Shows the level of the most precise area information for the match, district, city or a higher administrative level. The possible values are: "country", "state", "county", "city", "district", "street", "intersection", "houseNumber", "postalCode" and "landmark".

Returns:

The level of the most precise area information for the match, district, city or a higher administrative level.

getMatchQuality

public java.util.Map<java.lang.String,java.lang.Float> getMatchQuality()

Details about the quality of the result. Additional information about the accuracy of the result is available in the matchQuality dictionary. It contains one or more float values representing how well each individual search parameter was matched. The values will be in the range [0, 1] with a value of 1 indicating a perfect match. The possible keys are "State", "County", "City", "District", "Street", "SecondaryStreet", "HouseNumber", and "PostalCode". The "SecondaryStreet" key will be present if an intersection was specified in the geocode request. For example, if the request contained "1st St at 2nd Ave", the "Street" key would access the match value for "1st St" and the "SecondaryStreet" key would access the match value for "2nd Ave".

Returns:

Details about the quality of the result.

getLocation

public Location getLocation()

The location data of the geocode result.

Returns:

The Location of this geocode result.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object