edu.ucdavis.cstars.client.tasks

Class AddressCandidate

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.AddressCandidate

public class AddressCandidate
extends com.google.gwt.core.client.JavaScriptObject

Represents an address and its location. AddressCandidate has no constructor.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
AddressResult	getAddressAsObject() Address of the candidate.
java.lang.String	getAddressAsString() Use this when using single line address requests
JSObject	getAttributes() Name value pairs of field name and field value as defined in outFields in Locator.addressToLocations.
Point	getLocation() X- and y-coordinate of the candidate.
int	getScore() Numeric score between 0 and 100 for geocode candidates.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAddressAsObject

public final AddressResult getAddressAsObject()

Address of the candidate. It contains one property for each of the address fields defined by a geocode service. Each address field describes some part of the address information for the candidate.

Returns:

JSObject

getAddressAsString

public final java.lang.String getAddressAsString()

Use this when using single line address requests

Returns:

String.

getAttributes

public final JSObject getAttributes()

Name value pairs of field name and field value as defined in outFields in Locator.addressToLocations.

Returns:

JavaScriptObject

getLocation

public final Point getLocation()

X- and y-coordinate of the candidate.

Returns:

Point

getScore

public final int getScore()

Numeric score between 0 and 100 for geocode candidates. A candidate with a score of 100 means a perfect match, and 0 means no match.

Returns:

int