com.mapquest
Class GeoAddress

java.lang.Object
  extended bycom.mapquest.MQObject
      extended bycom.mapquest.Location
          extended bycom.mapquest.Address
              extended bycom.mapquest.GeoAddress
All Implemented Interfaces:
java.lang.Cloneable

public class GeoAddress
extends Address

Contains the results of geocoding an address.

See Also:
Address, LatLng

Field Summary
static int CLASS_ID
           
static java.lang.String CLASS_NAME
           
 
Fields inherited from class com.mapquest.MQObject
DEFAULT_ID, DEFAULT_NAME, DEFAULT_VERSION, FORMAT_NUMERIC_ID, FORMAT_TEXT_NAME, INVALID_ID, INVALID_NAME, INVALID_VERSION
 
Constructor Summary
GeoAddress()
          Default constructor.
GeoAddress(GeoAddress copy)
          Copy constructor.
 
Method Summary
 boolean equals(java.lang.Object otherObject)
          Compares this object to the specified object.
 int getClassId()
          Returns the numeric id of this class.
 java.lang.String getClassName()
          Returns the text name of this class.
 double getDistAlong()
          Get the Distance along the link where geocoded, or the distance from a link when returned from routing
 long getGEFID()
          Gets the GEFID of a GeoAddress object.
 LatLng getLatLng()
          Returns the LatLng component of this GeoAddress object.
 java.lang.String getResultCode()
          Returns the Result code of this GeoAddress object.
 java.lang.String getSourceId()
          Gets the geocode coverage name of the geocoder that performed the geocode
 int hashCode()
          Returns a hash code for this GeoAddress.
 void init()
          Initializes object.
 void setDistAlong(double dDistAlong)
          Set the Distance along the link where geocoded, or the distance from a link when returned from routing
 void setGEFID(long GEFID)
          Sets the GEFID of a GeoAddress object.
 void setLatLng(LatLng llLatLng)
          Sets the LatLng object of this GeoAddress.
 void setResultCode(java.lang.String strCode)
          Sets the Result Code of this GeoAddress object.
 void setSourceId(java.lang.String strSourceId)
          Sets the geocode coverage name of the geocoder that performed the geocode
 
Methods inherited from class com.mapquest.Address
getAdminArea, getCity, getCountry, getCounty, getPostalCode, getState, getStreet, setAdminArea, setCity, setCountry, setCounty, setPostalCode, setState, setStreet
 
Methods inherited from class com.mapquest.MQObject
clone, getFormat, getIdWithVersion, getNameWithVersion, getObjectVersion, getTypeId, getTypeName, getVerboseConsoleOutput, setFormat, setObjectVersion, setVerboseConsoleOutput, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_ID

public static final int CLASS_ID
See Also:
Constant Field Values

CLASS_NAME

public static final java.lang.String CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

GeoAddress

public GeoAddress()
Default constructor.


GeoAddress

public GeoAddress(GeoAddress copy)
Copy constructor.

Parameters:
copy - The GeoAddress object which is to be copied to this GeoAddress object.
Method Detail

init

public void init()
Initializes object.

Overrides:
init in class Address

getClassId

public int getClassId()
Returns the numeric id of this class.

Overrides:
getClassId in class Address
Returns:
the numeric id of this class.

getClassName

public java.lang.String getClassName()
Returns the text name of this class.

Overrides:
getClassName in class Address
Returns:
the text name of this class.

setLatLng

public void setLatLng(LatLng llLatLng)
Sets the LatLng object of this GeoAddress.

Parameters:
llLatLng - The LatLng object which contains the results that the corresponding components of this GeoAddress object is to be set to.

setResultCode

public void setResultCode(java.lang.String strCode)
Sets the Result Code of this GeoAddress object.

Parameters:
strCode - The quality of the Geocode match (for example Zip + 4, Address, and Intersection match).

setGEFID

public void setGEFID(long GEFID)
Sets the GEFID of a GeoAddress object.

Parameters:
GEFID - New GEFID for this object.

getLatLng

public LatLng getLatLng()
Returns the LatLng component of this GeoAddress object.

Returns:
The LatLng component of this GeoAddress object.

getResultCode

public java.lang.String getResultCode()
Returns the Result code of this GeoAddress object.

Returns:
The quality of the Geocode match. Refer to Users guide for more information.

getGEFID

public long getGEFID()
Gets the GEFID of a GeoAddress object.

Returns:
The GEFID of this object.

setDistAlong

public void setDistAlong(double dDistAlong)
Set the Distance along the link where geocoded, or the distance from a link when returned from routing

Parameters:
dDistAlong - the Distance

getDistAlong

public double getDistAlong()
Get the Distance along the link where geocoded, or the distance from a link when returned from routing

Returns:
the Distance

setSourceId

public void setSourceId(java.lang.String strSourceId)
Sets the geocode coverage name of the geocoder that performed the geocode

Parameters:
strSourceId - the source coverage id that the geocode was acquired from

getSourceId

public java.lang.String getSourceId()
Gets the geocode coverage name of the geocoder that performed the geocode

Returns:
the Source id

equals

public boolean equals(java.lang.Object otherObject)
Compares this object to the specified object. The result is true if and only if the argument is not null and is a GeoAddress object that has same attributes as this object.

Overrides:
equals in class Address
Parameters:
otherObject - the object to compare this GeoAddress against.
Returns:
true if the GeoAddress objects are equal; false otherwise.

hashCode

public int hashCode()
Returns a hash code for this GeoAddress.

Overrides:
hashCode in class Address
Returns:
a hash code value for this GeoAddress.