GeocodeAddress (geocodingservices - geocoding-api 5.1.796 API)

java.lang.Object
- com.mapinfo.geocode.GeocodeAddress

All Implemented Interfaces:

Address, GeoSerialize, Serializable
```
public class GeocodeAddress
extends Object
implements Address, GeoSerialize
```
This class implements the Address interface and is used to hold information on an address.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GeocodeAddress()
Creates a new, empty address.

GeocodeAddress(Address orig)
Copy constructor

Constructors
Constructor and Description
`GeocodeAddress()` Creates a new, empty address.
`GeocodeAddress(Address orig)` Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomField(String key, String value)` Allows a single custom key-value pair to be added to an address.
`Map<String,Object>`	`convertToMap()` Convert this object to a "map of maps" where each map is Map<String, Object>
`String`	`getAddressLastLine()` The address last line holds the the location level information (e.g.
`String`	`getAddressNumber()` Used to hold the house number information
`String`	`getAreaName1()` Used to represent the largest geographic division in an area, such as a state, province, or region
`String`	`getAreaName2()` Used to represent the secondary geographic division in an area, such as a county or district.
`String`	`getAreaName3()` Used to represent the city or town name
`String`	`getAreaName4()` Represents the smallest geographic division in an area, such as a city subdivision or locality
`String`	`getCountry()` The country of the address.
`Map<String,String>`	`getCustomFields()` The custom fields hold String key-value pairs.
`String`	`getMainAddressLine()` The main address line is use to input a single line (e.g., "1 Global Vw, Troy NY 12180", or the street line information (e.g., "1 Global Vw").
`String`	`getPlaceName()` Used to hold the name of a business, building, or location.
`String`	`getPostCode1()` Represents the main postal code.
`String`	`getPostCode2()` Represents the secondary postal code, if used.
`String`	`getStreetName()` Represents the street name, e.g., "West Main St".
`String`	`getUnitType()` Used to represent the unit type (such as "Apt" or "Suite") where appropriate
`String`	`getUnitValue()` Used to represent the unit value (e.g., "3B") where appropriate
`void`	`setAddressLastLine(String value)` The address last line is used to represent the location level information, e.g.
`void`	`setAddressNumber(String value)` Represents the house number information
`void`	`setAreaName1(String value)` Represents the largest geographic division in an area, such as a state, province, or region
`void`	`setAreaName2(String value)` Represents the secondary geographic division in an area, such as a county or district.
`void`	`setAreaName3(String value)` Represents the city or town name
`void`	`setAreaName4(String value)` Represents the smallest geographic division in an area, such as a city subdivision or locality
`void`	`setCountry(String value)` The country of the address.
`void`	`setCustomFields(Map<String,String> customFields)` Used to map of custom fields
`void`	`setMainAddressLine(String value)` The main address line is use to input a single line (e.g., "1 Global Vw, Troy NY 12180", or the street line information (e.g., "1 Global Vw").
`void`	`setPlaceName(String value)` Used to represent the name of a business, building, or location.
`void`	`setPostCode1(String value)` Represents the main postal code.
`void`	`setPostCode2(String value)` Represents the secondary postal code, if used.
`void`	`setStreetName(String value)` Represents the street name, e.g., "West Main St".
`void`	`setUnitType(String value)` Used to represent the unit type (such as "Apt" or "Suite") where appropriate
`void`	`setUnitValue(String value)` Used to represent the unit value (e.g., "3B") where appropriate
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GeocodeAddress
```
public GeocodeAddress()
```
    Creates a new, empty address. Note that Country must be populated in order to geocode.
  - GeocodeAddress
```
public GeocodeAddress(Address orig)
```
    Copy constructor
    
    Parameters:
    
    orig - Address to copy information from
- Method Detail
  - getMainAddressLine
```
public String getMainAddressLine()
```
    Description copied from interface: Address
    
    The main address line is use to input a single line (e.g., "1 Global Vw, Troy NY 12180", or the street line information (e.g., "1 Global Vw"). This information can alternatively be entered as street name, address number, and so on. On output this will hold correctly formatted main address line information for the country geocoded.
    
    Specified by:
    
    getMainAddressLine in interface Address
    
    Returns:
    
    String used to input single line, or street address line, or output street address line in a Candidate.
  - setMainAddressLine
```
public void setMainAddressLine(String value)
```
    Description copied from interface: Address
    
    The main address line is use to input a single line (e.g., "1 Global Vw, Troy NY 12180", or the street line information (e.g., "1 Global Vw"). This information can alternatively be entered as street name, address number, and so on. On output this will hold correctly formatted main address line information for the country geocoded.
    
    Specified by:
    
    setMainAddressLine in interface Address
    
    Parameters:
    
    value - String used to input single line, or street address line, or output street address line in a Candidate.
  - getAddressLastLine
```
public String getAddressLastLine()
```
    Description copied from interface: Address
    
    The address last line holds the the location level information (e.g. "Troy NY 12180"). This information can alternatively be found in separate fields as area name and post code data.
    
    Specified by:
    
    getAddressLastLine in interface Address
    
    Returns:
    
    String used to represent the address last line information.
  - setAddressLastLine
```
public void setAddressLastLine(String value)
```
    Description copied from interface: Address
    
    The address last line is used to represent the location level information, e.g. "Troy NY 12180". This information can alternatively be entered in separate fields as area name and post code data.
    
    Specified by:
    
    setAddressLastLine in interface Address
    
    Parameters:
    
    value - String used to represent the address last line information.
  - getPlaceName
```
public String getPlaceName()
```
    Description copied from interface: Address
    
    Used to hold the name of a business, building, or location.
    
    Specified by:
    
    getPlaceName in interface Address
    
    Returns:
    
    String used to represent place name.
  - setPlaceName
```
public void setPlaceName(String value)
```
    Description copied from interface: Address
    
    Used to represent the name of a business, building, or location.
    
    Specified by:
    
    setPlaceName in interface Address
    
    Parameters:
    
    value - String used to represent place name.
  - getAreaName1
```
public String getAreaName1()
```
    Description copied from interface: Address
    
    Used to represent the largest geographic division in an area, such as a state, province, or region
    
    Specified by:
    
    getAreaName1 in interface Address
    
    Returns:
    
    String used to represent largest geographic division of a country
  - setAreaName1
```
public void setAreaName1(String value)
```
    Description copied from interface: Address
    
    Represents the largest geographic division in an area, such as a state, province, or region
    
    Specified by:
    
    setAreaName1 in interface Address
    
    Parameters:
    
    value - String used to represent largest geographic division of a country
  - getAreaName2
```
public String getAreaName2()
```
    Description copied from interface: Address
    
    Used to represent the secondary geographic division in an area, such as a county or district.
    
    Specified by:
    
    getAreaName2 in interface Address
    
    Returns:
    
    String used to represent secondary geographic division of a country
  - setAreaName2
```
public void setAreaName2(String value)
```
    Description copied from interface: Address
    
    Represents the secondary geographic division in an area, such as a county or district.
    
    Specified by:
    
    setAreaName2 in interface Address
    
    Parameters:
    
    value - String used to represent secondary geographic division of a country
  - getAreaName3
```
public String getAreaName3()
```
    Description copied from interface: Address
    
    Used to represent the city or town name
    
    Specified by:
    
    getAreaName3 in interface Address
    
    Returns:
    
    String used to represent city or town name
  - setAreaName3
```
public void setAreaName3(String value)
```
    Description copied from interface: Address
    
    Represents the city or town name
    
    Specified by:
    
    setAreaName3 in interface Address
    
    Parameters:
    
    value - String used to represent city or town name
  - getAreaName4
```
public String getAreaName4()
```
    Description copied from interface: Address
    
    Represents the smallest geographic division in an area, such as a city subdivision or locality
    
    Specified by:
    
    getAreaName4 in interface Address
    
    Returns:
    
    String used to represent smallest geographic division of a country
  - setAreaName4
```
public void setAreaName4(String value)
```
    Description copied from interface: Address
    
    Represents the smallest geographic division in an area, such as a city subdivision or locality
    
    Specified by:
    
    setAreaName4 in interface Address
    
    Parameters:
    
    value - String used to represent smallest geographic division of a country
  - getPostCode1
```
public String getPostCode1()
```
    Description copied from interface: Address
    
    Represents the main postal code.
    
    Specified by:
    
    getPostCode1 in interface Address
    
    Returns:
    
    String used to represent main postal code
  - setPostCode1
```
public void setPostCode1(String value)
```
    Description copied from interface: Address
    
    Represents the main postal code.
    
    Specified by:
    
    setPostCode1 in interface Address
    
    Parameters:
    
    value - String used to represent main postal code
  - getPostCode2
```
public String getPostCode2()
```
    Description copied from interface: Address
    
    Represents the secondary postal code, if used. An example of a secondary postal code is the optional "plus 4" 4 digit extension to the USA 5 digit main postal code.
    
    Specified by:
    
    getPostCode2 in interface Address
    
    Returns:
    
    String used to represent main postal code
  - setPostCode2
```
public void setPostCode2(String value)
```
    Description copied from interface: Address
    
    Represents the secondary postal code, if used. An example of a secondary postal code is the optional "plus 4" 4 digit extension to the USA 5 digit main postal code.
    
    Specified by:
    
    setPostCode2 in interface Address
    
    Parameters:
    
    value - String used to represent main postal code
  - getCountry
```
public String getCountry()
```
    Description copied from interface: Address
    
    The country of the address. This is represented by the ISO-3166 3 character abbreviation for the country
    
    Specified by:
    
    getCountry in interface Address
    
    Returns:
    
    String used to represent country
  - setCountry
```
public void setCountry(String value)
```
    Description copied from interface: Address
    
    The country of the address. This Is represented by the ISO-3166 3 character abbreviation for the country
    
    Specified by:
    
    setCountry in interface Address
    
    Parameters:
    
    value - String used to represent country
  - getAddressNumber
```
public String getAddressNumber()
```
    Description copied from interface: Address
    
    Used to hold the house number information
    
    Specified by:
    
    getAddressNumber in interface Address
    
    Returns:
    
    String used to represent house number
  - setAddressNumber
```
public void setAddressNumber(String value)
```
    Description copied from interface: Address
    
    Represents the house number information
    
    Specified by:
    
    setAddressNumber in interface Address
    
    Parameters:
    
    value - String used to represent house number
  - getStreetName
```
public String getStreetName()
```
    Description copied from interface: Address
    
    Represents the street name, e.g., "West Main St".
    
    Specified by:
    
    getStreetName in interface Address
    
    Returns:
    
    String used to represent the street name
  - setStreetName
```
public void setStreetName(String value)
```
    Description copied from interface: Address
    
    Represents the street name, e.g., "West Main St".
    
    Specified by:
    
    setStreetName in interface Address
    
    Parameters:
    
    value - String used to represent the street name
  - getUnitType
```
public String getUnitType()
```
    Description copied from interface: Address
    
    Used to represent the unit type (such as "Apt" or "Suite") where appropriate
    
    Specified by:
    
    getUnitType in interface Address
    
    Returns:
    
    String used to represent the unit type
  - setUnitType
```
public void setUnitType(String value)
```
    Description copied from interface: Address
    
    Used to represent the unit type (such as "Apt" or "Suite") where appropriate
    
    Specified by:
    
    setUnitType in interface Address
    
    Parameters:
    
    value - String used to represent the unit type
  - getUnitValue
```
public String getUnitValue()
```
    Description copied from interface: Address
    
    Used to represent the unit value (e.g., "3B") where appropriate
    
    Specified by:
    
    getUnitValue in interface Address
    
    Returns:
    
    String used to represent the unit value
  - setUnitValue
```
public void setUnitValue(String value)
```
    Description copied from interface: Address
    
    Used to represent the unit value (e.g., "3B") where appropriate
    
    Specified by:
    
    setUnitValue in interface Address
    
    Parameters:
    
    value - String used to represent the unit value
  - getCustomFields
```
public Map<String,String> getCustomFields()
```
    Description copied from interface: Address
    
    The custom fields hold String key-value pairs. If the underlying information has a custom output value, that is typically returned by mapping the defined key to the value.
    
    Specified by:
    
    getCustomFields in interface Address
    
    Returns:
    
    Map of custom values
  - setCustomFields
```
public void setCustomFields(Map<String,String> customFields)
```
    Description copied from interface: Address
    
    Used to map of custom fields
    
    Specified by:
    
    setCustomFields in interface Address
    
    Parameters:
    
    customFields - map of custom fields
  - addCustomField
```
public void addCustomField(String key,
                           String value)
```
    Description copied from interface: Address
    
    Allows a single custom key-value pair to be added to an address. If you add an existing key name with a null value, that removes the custom value.
    
    Specified by:
    
    addCustomField in interface Address
    
    Parameters:
    
    key - this must be defined and understood by the target geocoder
    
    value - the value to be input
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - convertToMap
```
public Map<String,Object> convertToMap()
```
    Convert this object to a "map of maps" where each map is Map<String, Object>
    
    Specified by:
    
    convertToMap in interface GeoSerialize
    
    Returns:
    
    a map of the properties in this class, one entry of which is a contained map containing a map of custom values

Class GeocodeAddress

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GeocodeAddress

GeocodeAddress

Method Detail

getMainAddressLine

setMainAddressLine

getAddressLastLine

setAddressLastLine

getPlaceName

setPlaceName

getAreaName1

setAreaName1

getAreaName2

setAreaName2

getAreaName3

setAreaName3

getAreaName4

setAreaName4

getPostCode1

setPostCode1

getPostCode2

setPostCode2

getCountry

setCountry

getAddressNumber

setAddressNumber

getStreetName

setStreetName

getUnitType

setUnitType

getUnitValue

setUnitValue

getCustomFields

setCustomFields

addCustomField

toString

convertToMap