Class: IWGeocodingResult

IWGeocodingResult

A geocoded address result.

This class is part of the module geocoding.


new IWGeocodingResult()

Creates a new geocoding result.

Methods


getAddress()

Returns the geocoded address.
Returns:
Type
IWAddress

getHitProbability()

Returns the hit probability of the geocoded address.
Returns:
Type
number

getMatchCode()

Returns the matchcode of the geocoded address.

The following matchcodes are defined:

  • -1: indicates an error
  •  1: house exactly
  •  2: street exactly
  •  3: city exactly
  •  4: zip code exactly
Returns:
Type
number

getQuality()

Returns a string which represents the quality of the geocoded address.
Returns:
Type
String

setAddress(address)

Sets the address for this geocoding result.
Parameters:
Name Type Description
address IWAddress the geocoded address
Returns:
Type
void

setHitProbability(hitprobability)

Sets the hit probability of the geocoded address.
Parameters:
Name Type Description
hitprobability number
Returns:
Type
void

setMatchCode(matchcode)

Sets the matchcode of the geocoded address.
Parameters:
Name Type Description
matchcode number
Returns:
Type
void

setQuality(quality)

Sets a string which represents the quality of the geocoded address.
Parameters:
Name Type Description
quality String
Returns:
Type
void

toString()

Returns a string representation of this geocoding result.
Returns:
Type
String