PostalAddress

java.lang.Object
- org.ka2ddo.yaac.osm.PostalAddress

All Implemented Interfaces:

java.lang.Cloneable
```
public class PostalAddress
extends java.lang.Object
implements java.lang.Cloneable
```
A collection of the postal address tags in OSM for a particular element (Node or Way), for use in future address lookups. This covers the tags "addr:city", "addr:country", "addr:housename", "addr:housenumber", "addr:place", "addr:postcode", "addr:province", "addr:state", "addr:street". "addr:town", and "addr:village",

Since:

PROVIDER_API_VERSION == 47

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`city` Value of the "addr:city", "addr:town", or "addr:village" tag.
`java.lang.String`	`country` Value of the "addr:country" tag.
`java.lang.String`	`houseNumber` Value of the "addr:housenumber" or "addr:housename" tag.
`long`	`id` The OSM element ID for the Node or Way.
`static int`	`INV_NO_CITY` Error bitmask for a PostalAddress without a `city`.
`static int`	`INV_NO_HOUSENUMBER` Error bitmask for a PostalAddress without a `houseNumber`.
`static int`	`INV_NO_STREET` Error bitmask for a PostalAddress without a `street`.
`static int`	`INV_PERFECT_FAILURE` Combination of error bits that implies an unusable PostalAddress, where if any one of these bits is missing (and no other error bits are set), then the partial address can be stored (and potentially fixed by later OSM records or by post-import correction utilities).
`static int`	`INV_TOO_LONG_CITY` Error bitmask for a PostalAddress with too long a `city`.
`static int`	`INV_TOO_LONG_COUNTRY` Error bitmask for a PostalAddress with too long a `country`.
`static int`	`INV_TOO_LONG_HOUSENUMBER` Error bitmask for a PostalAddress with too long a `houseNumber`.
`static int`	`INV_TOO_LONG_POSTCODE` Error bitmask for a PostalAddress with too long a `postCode`.
`static int`	`INV_TOO_LONG_STATEPROVINCE` Error bitmask for a PostalAddress with too long a `state or province`.
`static int`	`INV_TOO_LONG_STREET` Error bitmask for a PostalAddress with too long a `street`.
`boolean`	`isWay` Indicates if the `id` refers to a `Way` (true) or `Node` (false).
`int`	`latitude` Latitude of address in millionths of degrees North.
`int`	`longitude` Longitude of address in millionths of degrees East.
`static java.lang.String[]`	`POSTAL_QUADRANTS` Array pf quadrant suffixes for postal address tables.
`java.lang.String`	`postCode` Value of the "addr:postcode" tag.
`java.lang.String`	`stateProvince` Value of the "addr:state" or "addr:province" tag.
`java.lang.String`	`street` Value of the "addr:street" or "addr:place" tag.

Constructor Summary

Constructors
Constructor and Description
`PostalAddress()` Create an empty PostalAddress.
`PostalAddress(boolean isWay, long id, int latitude, int longitude)` Create a PostalAddress record with the geographical (not postal) indexing information.
`PostalAddress(java.sql.ResultSet rs)` Create a PostalAddress object from the currently pointed record in a ResultSet.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Reset the PostalAddress back to all fields empty so it can be loaded for the next Node or Way with address dara in it.
`java.lang.Object`	`clone()` Creates and returns a copy of this object.
`int`	`getInvalidReasons()` Get the reasons why a PostalRecord is not acceptable.
`int`	`getQuadrantIndex()` Get the quadrant index for the geographical coordinates of this PostalAddress.
`static int`	`getQuadrantIndex(int latitude, int longitude)` Determine which planetary quadrant (database table) an address should be stored in.
`boolean`	`isEmpty()` Test whether this PostalAddress has enough information to be worth saving.
`void`	`set(java.lang.String fieldName, java.lang.String value)` Copy an OSM node or way tag that is part of a postal address.

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

- Field Detail
  - POSTAL_QUADRANTS
```
public static final java.lang.String[] POSTAL_QUADRANTS
```
    Array pf quadrant suffixes for postal address tables. Note that the Western quadrants actually are separated from the Eastern quadrants at longitude -20 (20 degrees West) so as to avoid slicing off the western tips of Europe and Africa.
  - INV_NO_HOUSENUMBER
```
public static final int INV_NO_HOUSENUMBER
```
    Error bitmask for a PostalAddress without a houseNumber.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_TOO_LONG_HOUSENUMBER
```
public static final int INV_TOO_LONG_HOUSENUMBER
```
    Error bitmask for a PostalAddress with too long a houseNumber.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_NO_STREET
```
public static final int INV_NO_STREET
```
    Error bitmask for a PostalAddress without a street.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_TOO_LONG_STREET
```
public static final int INV_TOO_LONG_STREET
```
    Error bitmask for a PostalAddress with too long a street.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_NO_CITY
```
public static final int INV_NO_CITY
```
    Error bitmask for a PostalAddress without a city.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_TOO_LONG_CITY
```
public static final int INV_TOO_LONG_CITY
```
    Error bitmask for a PostalAddress with too long a city.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_TOO_LONG_STATEPROVINCE
```
public static final int INV_TOO_LONG_STATEPROVINCE
```
    Error bitmask for a PostalAddress with too long a state or province.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_TOO_LONG_POSTCODE
```
public static final int INV_TOO_LONG_POSTCODE
```
    Error bitmask for a PostalAddress with too long a postCode.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_TOO_LONG_COUNTRY
```
public static final int INV_TOO_LONG_COUNTRY
```
    Error bitmask for a PostalAddress with too long a country.
    
    See Also:
    
    getInvalidReasons(), Constant Field Values
  - INV_PERFECT_FAILURE
```
public static final int INV_PERFECT_FAILURE
```
    Combination of error bits that implies an unusable PostalAddress, where if any one of these bits is missing (and no other error bits are set), then the partial address can be stored (and potentially fixed by later OSM records or by post-import correction utilities).
    
    See Also:
    
    Constant Field Values
  - id
```
public long id
```
    The OSM element ID for the Node or Way. Note this may have a negative value for cases where an extremely tiny Way is optimized into a Node, or when a Relation is treated as a large Way.
  - latitude
```
public int latitude
```
    Latitude of address in millionths of degrees North.
  - longitude
```
public int longitude
```
    Longitude of address in millionths of degrees East.
  - isWay
```
public boolean isWay
```
    Indicates if the id refers to a Way (true) or Node (false).
  - houseNumber
```
public java.lang.String houseNumber
```
    Value of the "addr:housenumber" or "addr:housename" tag.
  - street
```
public java.lang.String street
```
    Value of the "addr:street" or "addr:place" tag.
  - city
```
public java.lang.String city
```
    Value of the "addr:city", "addr:town", or "addr:village" tag.
  - stateProvince
```
public java.lang.String stateProvince
```
    Value of the "addr:state" or "addr:province" tag.
  - postCode
```
public java.lang.String postCode
```
    Value of the "addr:postcode" tag.
  - country
```
public java.lang.String country
```
    Value of the "addr:country" tag. Note this can usually be inferred from national borders if not provided.
- Constructor Detail
  - PostalAddress
```
public PostalAddress()
```
    Create an empty PostalAddress.
  - PostalAddress
```
public PostalAddress(boolean isWay,
                     long id,
                     int latitude,
                     int longitude)
```
    Create a PostalAddress record with the geographical (not postal) indexing information.
    
    Parameters:
    
    isWay - boolean true if id is for a Way, false for a Node
    
    id - long numeric ID for the Way or Node
    
    latitude - int latitude in millionths of degrees North
    
    longitude - int longitude in millionths of degrees East
  - PostalAddress
```
public PostalAddress(java.sql.ResultSet rs)
              throws java.sql.SQLException
```
    Create a PostalAddress object from the currently pointed record in a ResultSet.
    
    Parameters:
    
    rs - ResultSet containing the DB record to extract
    
    Throws:
    
    java.sql.SQLException - if the fields couldn't be extracted from the ResultSet (wrong table queried?)
- Method Detail
  - clear
```
public void clear()
```
    Reset the PostalAddress back to all fields empty so it can be loaded for the next Node or Way with address dara in it.
  - isEmpty
```
public boolean isEmpty()
```
    Test whether this PostalAddress has enough information to be worth saving.
    
    Returns:
    
    boolean true if insufficient information to be worth saving
  - getInvalidReasons
```
public int getInvalidReasons()
```
    Get the reasons why a PostalRecord is not acceptable.
    
    Returns:
    
    bitmask of reasons why a PostalAddress record should not or can not be written to the database table
    
    See Also:
    
    INV_NO_HOUSENUMBER, INV_TOO_LONG_HOUSENUMBER, INV_NO_STREET, INV_TOO_LONG_STREET, INV_NO_CITY, INV_TOO_LONG_CITY, INV_TOO_LONG_STATEPROVINCE, INV_TOO_LONG_POSTCODE, INV_TOO_LONG_COUNTRY
  - set
```
public void set(java.lang.String fieldName,
                java.lang.String value)
```
    Copy an OSM node or way tag that is part of a postal address.
    
    Parameters:
    
    fieldName - OSM tag name
    
    value - String value associated with the tag to save
  - getQuadrantIndex
```
public static int getQuadrantIndex(int latitude,
                                   int longitude)
```
    Determine which planetary quadrant (database table) an address should be stored in.
    
    Parameters:
    
    latitude - latitude in millionths of degrees North
    
    longitude - longitude in millionths of degrees East
    
    Returns:
    
    quadrant index for the geographical coordinates
  - getQuadrantIndex
```
public int getQuadrantIndex()
```
    Get the quadrant index for the geographical coordinates of this PostalAddress.
    
    Returns:
    
    quadrant index for the address's coordinates
  - clone
```
public java.lang.Object clone()
```
    Creates and returns a copy of this object. This method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone of this instance.
    
    See Also:
    
    Cloneable

Class PostalAddress

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POSTAL_QUADRANTS

INV_NO_HOUSENUMBER

INV_TOO_LONG_HOUSENUMBER

INV_NO_STREET

INV_TOO_LONG_STREET

INV_NO_CITY

INV_TOO_LONG_CITY

INV_TOO_LONG_STATEPROVINCE

INV_TOO_LONG_POSTCODE

INV_TOO_LONG_COUNTRY

INV_PERFECT_FAILURE

id

latitude

longitude

isWay

houseNumber

street

city

stateProvince

postCode

country

Constructor Detail

PostalAddress

PostalAddress

PostalAddress

Method Detail

clear

isEmpty

getInvalidReasons

set

getQuadrantIndex

getQuadrantIndex

clone