Address (Nominatim Java API client 3.3 API)

java.lang.Object
- fr.dudie.nominatim.model.Address

public final class Address
extends Object

Represents a search result.

 {
 
     "place_id": "49135222",
     "licence": "Data Copyright OpenStreetMap Contributors, Some Rights Reserved. CC-BY-SA 2.0.",
     "osm_type": "way",
     "osm_id": "42928962",
     "boundingbox": [
         "48.1190567016602",
         "48.1191635131836",
         "-1.6499342918396",
         "-1.64988231658936"
     ],
     "polygonpoints": [
         [
             "34.50669",
             "28.0885916"
         ],
         [
             "34.5183936",
             "28.1684821"
         ]
     ],
     "lat": "48.11911095",
     "lon": "-1.6499083",
     "display_name": "Boulevard de Vitré, Jeanne d'Arc, Rennes, Britanny, 35042, France",
     "class": "highway",
     "type": "primary",
     "address": {
         "road": "Boulevard de Vitré",
         "suburb": "Jeanne d'Arc",
         "city": "Rennes",
         "administrative": "Rennes",
         "state": "Britanny",
         "postcode": "35042",
         "country": "France",
         "country_code": "fr"
     }
 
 },

Author:: Jérémie Huchet

Constructor Summary

Constructors
Constructor and Description

Address()

Constructors
Constructor and Description
`Address()`

Method Summary

Methods
Modifier and Type	Method and Description
`Element[]`	`getAddressElements()` Gets the elements describing the address (ex: road, city, coutry...).
`BoundingBox`	`getBoundingBox()` Gets the bounding box enclosing the element.
`String`	`getDisplayName()` Gets the address display name.
`String`	`getElementClass()` Gets the OpenStreetMap element class (ex: highway).
`String`	`getElementType()` Gets the penStreetMap element type (ex: residential).
`com.vividsolutions.jts.geom.Geometry`	`getGeojson()`
`double`	`getImportance()` Gets the address importance.
`double`	`getLatitude()` Gets the address latitude.
`int`	`getLatitudeE6()` Gets the address latitude.
`String`	`getLicence()` Gets the data licence.
`double`	`getLongitude()` Gets the address longitude.
`int`	`getLongitudeE6()` Gets the address longitude.
`Element[]`	`getNameDetails()` Sets the elements describing the namedetails (ex: name, operator, short name...).
`String`	`getOsmId()` Gets the OpenStreetMap identifier.
`String`	`getOsmType()` Gets the OpenStreetMap type.
`long`	`getPlaceId()` Gets the OpenStreetMap place id.
`int`	`getPlaceRank()` Gets the elements rank (ex: 30 = building).
`PolygonPoint[]`	`getPolygonPoints()` Gets the polygon points representing the element.
`String`	`getWkt()` Gets polygon's WKT string.
`void`	`setAddressElements(Element[] addressElements)` Sets the elements describing the address (ex: road, city, coutry...).
`void`	`setBoundingBox(BoundingBox boundingBox)` Sets the bounding box enclosing the element.
`void`	`setDisplayName(String displayName)` Sets the address display name.
`void`	`setElementClass(String elementClass)` Sets the OpenStreetMap element class (ex: highway).
`void`	`setElementType(String elementType)` Sets the penStreetMap element type (ex: residential).
`void`	`setGeojson(com.vividsolutions.jts.geom.Geometry geojson)`
`void`	`setImportance(double importance)` Gets the address importance.
`void`	`setLatitude(double latitude)` Sets the address latitude.
`void`	`setLatitudeE6(int latitude)` Sets the address latitude.
`void`	`setLicence(String licence)` Sets the data licence.
`void`	`setLongitude(double longitude)` Sets the address longitude.
`void`	`setLongitudeE6(int longitude)` Sets the address longitude.
`void`	`setNameDetails(Element[] namedetails)` Sets the elements describing the namedetails (ex: name, operator, short name...).
`void`	`setOsmId(String osmId)` Sets the OpenStreetMap identifier.
`void`	`setOsmType(String osmType)` Sets the OpenStreetMap type.
`void`	`setPlaceId(long placeId)` Sets the OpenStreetMap place id.
`void`	`setPlaceRank(int placeRank)` Sets the elements rank (ex: 30 = building).
`void`	`setPolygonPoints(PolygonPoint[] polygonPoints)` Sets the polygon points representing the element.
`String`	`setWkt(String wkt)` Sets a polygon's WKT string.

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

- Constructor Detail
  - Address
```
public Address()
```
- Method Detail
  - getPlaceId
```
public long getPlaceId()
```
    Gets the OpenStreetMap place id.
    
    Returns:
    the OpenStreetMap place id
  - setPlaceId
```
public void setPlaceId(long placeId)
```
    Sets the OpenStreetMap place id.
    
    Parameters:
    placeId - the OpenStreetMap place id to set
  - getLicence
```
public String getLicence()
```
    Gets the data licence.
    
    Returns:
    the data licence
  - setLicence
```
public void setLicence(String licence)
```
    Sets the data licence.
    
    Parameters:
    licence - the data licence to set
  - getOsmType
```
public String getOsmType()
```
    Gets the OpenStreetMap type.
    
    Returns:
    the OpenStreetMap type
  - setOsmType
```
public void setOsmType(String osmType)
```
    Sets the OpenStreetMap type.
    
    Parameters:
    osmType - the OpenStreetMap type to set
  - getOsmId
```
public String getOsmId()
```
    Gets the OpenStreetMap identifier.
    
    Returns:
    the OpenStreetMap identifier
  - setOsmId
```
public void setOsmId(String osmId)
```
    Sets the OpenStreetMap identifier.
    
    Parameters:
    osmId - the OpenStreetMap identifier to set
  - getBoundingBox
```
public BoundingBox getBoundingBox()
```
    Gets the bounding box enclosing the element.
    
    Returns:
    the bounding box enclosing the element
  - setBoundingBox
```
public void setBoundingBox(BoundingBox boundingBox)
```
    Sets the bounding box enclosing the element.
    
    Parameters:
    boundingBox - the bounding box enclosing the element to set
  - getPolygonPoints
```
public PolygonPoint[] getPolygonPoints()
```
    Gets the polygon points representing the element.
    
    Returns:
    the polygon points representing the element
  - setPolygonPoints
```
public void setPolygonPoints(PolygonPoint[] polygonPoints)
```
    Sets the polygon points representing the element.
    
    Parameters:
    polygonPoints - the polygon points representing the element to set
  - getGeojson
```
public com.vividsolutions.jts.geom.Geometry getGeojson()
```
    Returns:
    the geojson
  - setGeojson
```
public void setGeojson(com.vividsolutions.jts.geom.Geometry geojson)
```
    Parameters:
    geojson - the geojson to set
  - getLongitude
```
public double getLongitude()
```
    Gets the address longitude.
    
    Returns:
    the address longitude
  - getLongitudeE6
```
public int getLongitudeE6()
```
    Gets the address longitude.
    
    Returns:
    the address longitude
  - setLongitude
```
public void setLongitude(double longitude)
```
    Sets the address longitude.
    
    Parameters:
    longitude - the address longitude to set
  - setLongitudeE6
```
public void setLongitudeE6(int longitude)
```
    Sets the address longitude.
    
    Parameters:
    longitude - the address longitude to set
  - getLatitude
```
public double getLatitude()
```
    Gets the address latitude.
    
    Returns:
    the address latitude
  - getLatitudeE6
```
public int getLatitudeE6()
```
    Gets the address latitude.
    
    Returns:
    the address latitude
  - setLatitude
```
public void setLatitude(double latitude)
```
    Sets the address latitude.
    
    Parameters:
    latitude - the address latitude to set
  - setLatitudeE6
```
public void setLatitudeE6(int latitude)
```
    Sets the address latitude.
    
    Parameters:
    latitude - the address latitude to set
  - getDisplayName
```
public String getDisplayName()
```
    Gets the address display name.
    
    Returns:
    the address display name
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Sets the address display name.
    
    Parameters:
    displayName - the address display name to set
  - getElementClass
```
public String getElementClass()
```
    Gets the OpenStreetMap element class (ex: highway).
    
    Returns:
    the OpenStreetMap element class (ex: highway)
  - setElementClass
```
public void setElementClass(String elementClass)
```
    Sets the OpenStreetMap element class (ex: highway).
    
    Parameters:
    elementClass - the OpenStreetMap element class (ex: highway) to set
  - getElementType
```
public String getElementType()
```
    Gets the penStreetMap element type (ex: residential).
    
    Returns:
    the penStreetMap element type (ex: residential)
  - setElementType
```
public void setElementType(String elementType)
```
    Sets the penStreetMap element type (ex: residential).
    
    Parameters:
    elementType - the penStreetMap element type (ex: residential) to set
  - getAddressElements
```
public Element[] getAddressElements()
```
    Gets the elements describing the address (ex: road, city, coutry...).
    
    Returns:
    the elements describing the address (ex: road, city, coutry...)
  - setAddressElements
```
public void setAddressElements(Element[] addressElements)
```
    Sets the elements describing the address (ex: road, city, coutry...).
    
    Parameters:
    addressElements - the elements describing the address (ex: road, city, coutry...) to set
  - getNameDetails
```
public Element[] getNameDetails()
```
    Sets the elements describing the namedetails (ex: name, operator, short name...).
    
    Returns:
    name
  - setNameDetails
```
public void setNameDetails(Element[] namedetails)
```
    Sets the elements describing the namedetails (ex: name, operator, short name...).
    
    Parameters:
    namedetails - the elements describing the namedetails (ex: name, operator, short name...)
  - getPlaceRank
```
public int getPlaceRank()
```
    Gets the elements rank (ex: 30 = building).
    
    Returns:
    the elements elements rank (ex: 30 = building).
  - setPlaceRank
```
public void setPlaceRank(int placeRank)
```
    Sets the elements rank (ex: 30 = building).
    
    Parameters:
    rank - the elements elements rank (ex: 30 = building) to set
  - getImportance
```
public double getImportance()
```
    Gets the address importance.
    
    Returns:
    the address importance
  - setImportance
```
public void setImportance(double importance)
```
    Gets the address importance.
  - getWkt
```
public String getWkt()
```
    Gets polygon's WKT string.
    
    Returns:
    the polygon's WKT string; NULL if not available or applicable.
  - setWkt
```
public String setWkt(String wkt)
```
    Sets a polygon's WKT string.
    
    Parameters:
    wkt - the WKT string to set.

Class Address

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Address

Method Detail

getPlaceId

setPlaceId

getLicence

setLicence

getOsmType

setOsmType

getOsmId

setOsmId

getBoundingBox

setBoundingBox

getPolygonPoints

setPolygonPoints

getGeojson

setGeojson

getLongitude

getLongitudeE6

setLongitude

setLongitudeE6

getLatitude

getLatitudeE6

setLatitude

setLatitudeE6

getDisplayName

setDisplayName

getElementClass

setElementClass

getElementType

setElementType

getAddressElements

setAddressElements

getNameDetails

setNameDetails

getPlaceRank

setPlaceRank

getImportance

setImportance

getWkt

setWkt