Address (geocodingservices - geocoding-api 5.1.854 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeocodeAddress
```
public interface Address
extends Serializable
```
Implementations of this interface are used to hold information representing an address. Most of the standard parts of an address have individual set and get operations. For custom address output information that may only apply in a specific country, the Address.getCustomFields method will return a map containing any country specific information.

Method Summary

All Methods Instance Methods Abstract 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.
`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

- Method Detail
  - getMainAddressLine
```
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"). 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.
    
    Returns:
    
    String used to input single line, or street address line, or output street address line in a Candidate.
  - setMainAddressLine
```
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"). 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.
    
    Parameters:
    
    value - String used to input single line, or street address line, or output street address line in a Candidate.
  - getAddressLastLine
```
String getAddressLastLine()
```
    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.
    
    Returns:
    
    String used to represent the address last line information.
  - setAddressLastLine
```
void setAddressLastLine(String value)
```
    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.
    
    Parameters:
    
    value - String used to represent the address last line information.
  - getPlaceName
```
String getPlaceName()
```
    Used to hold the name of a business, building, or location.
    
    Returns:
    
    String used to represent place name.
  - setPlaceName
```
void setPlaceName(String value)
```
    Used to represent the name of a business, building, or location.
    
    Parameters:
    
    value - String used to represent place name.
  - getAreaName1
```
String getAreaName1()
```
    Used to represent the largest geographic division in an area, such as a state, province, or region
    
    Returns:
    
    String used to represent largest geographic division of a country
  - setAreaName1
```
void setAreaName1(String value)
```
    Represents the largest geographic division in an area, such as a state, province, or region
    
    Parameters:
    
    value - String used to represent largest geographic division of a country
  - getAreaName2
```
String getAreaName2()
```
    Used to represent the secondary geographic division in an area, such as a county or district.
    
    Returns:
    
    String used to represent secondary geographic division of a country
  - setAreaName2
```
void setAreaName2(String value)
```
    Represents the secondary geographic division in an area, such as a county or district.
    
    Parameters:
    
    value - String used to represent secondary geographic division of a country
  - getAreaName3
```
String getAreaName3()
```
    Used to represent the city or town name
    
    Returns:
    
    String used to represent city or town name
  - setAreaName3
```
void setAreaName3(String value)
```
    Represents the city or town name
    
    Parameters:
    
    value - String used to represent city or town name
  - getAreaName4
```
String getAreaName4()
```
    Represents the smallest geographic division in an area, such as a city subdivision or locality
    
    Returns:
    
    String used to represent smallest geographic division of a country
  - setAreaName4
```
void setAreaName4(String value)
```
    Represents the smallest geographic division in an area, such as a city subdivision or locality
    
    Parameters:
    
    value - String used to represent smallest geographic division of a country
  - getPostCode1
```
String getPostCode1()
```
    Represents the main postal code.
    
    Returns:
    
    String used to represent main postal code
  - setPostCode1
```
void setPostCode1(String value)
```
    Represents the main postal code.
    
    Parameters:
    
    value - String used to represent main postal code
  - getPostCode2
```
String getPostCode2()
```
    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.
    
    Returns:
    
    String used to represent main postal code
  - setPostCode2
```
void setPostCode2(String value)
```
    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.
    
    Parameters:
    
    value - String used to represent main postal code
  - getCountry
```
String getCountry()
```
    The country of the address. This is represented by the ISO-3166 3 character abbreviation for the country
    
    Returns:
    
    String used to represent country
  - setCountry
```
void setCountry(String value)
```
    The country of the address. This Is represented by the ISO-3166 3 character abbreviation for the country
    
    Parameters:
    
    value - String used to represent country
  - getAddressNumber
```
String getAddressNumber()
```
    Used to hold the house number information
    
    Returns:
    
    String used to represent house number
  - setAddressNumber
```
void setAddressNumber(String value)
```
    Represents the house number information
    
    Parameters:
    
    value - String used to represent house number
  - getStreetName
```
String getStreetName()
```
    Represents the street name, e.g., "West Main St".
    
    Returns:
    
    String used to represent the street name
  - setStreetName
```
void setStreetName(String value)
```
    Represents the street name, e.g., "West Main St".
    
    Parameters:
    
    value - String used to represent the street name
  - getUnitType
```
String getUnitType()
```
    Used to represent the unit type (such as "Apt" or "Suite") where appropriate
    
    Returns:
    
    String used to represent the unit type
  - setUnitType
```
void setUnitType(String value)
```
    Used to represent the unit type (such as "Apt" or "Suite") where appropriate
    
    Parameters:
    
    value - String used to represent the unit type
  - getUnitValue
```
String getUnitValue()
```
    Used to represent the unit value (e.g., "3B") where appropriate
    
    Returns:
    
    String used to represent the unit value
  - setUnitValue
```
void setUnitValue(String value)
```
    Used to represent the unit value (e.g., "3B") where appropriate
    
    Parameters:
    
    value - String used to represent the unit value
  - getCustomFields
```
Map<String,String> getCustomFields()
```
    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.
    
    Returns:
    
    Map of custom values
  - setCustomFields
```
void setCustomFields(Map<String,String> customFields)
```
    Used to map of custom fields
    
    Parameters:
    
    customFields - map of custom fields
  - addCustomField
```
void addCustomField(String key,
                    String value)
```
    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.
    
    Parameters:
    
    key - this must be defined and understood by the target geocoder
    
    value - the value to be input

Interface Address

Method Summary

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