Package org.localify.dto.geocoding

Record Class PlaceResults

java.lang.Object

java.lang.Record

org.localify.dto.geocoding.PlaceResults

Record Components:

results -

public record PlaceResults(List<PlaceResults.Place> results)
extends Record

Results from the Apple Geocoding API. Example for Ithaca, NY:

 {
        "results": [
                {
                        "coordinate": {
                                "latitude": 42.438627,
                                "longitude": -76.498676
            },
                        "displayMapRegion": {
                                "southLatitude": 42.418327,
                                "westLongitude": -76.526947,
                                "northLatitude": 42.467079,
                                "eastLongitude": -76.469803
            },
                        "name": "Ithaca",
                        "formattedAddressLines": [
                                "Ithaca, NY",
                                "United States"
                        ],
                        "structuredAddress": {
                                "administrativeArea": "New York",
                                "administrativeAreaCode": "NY",
                                "locality": "Ithaca"
            },
                        "country": "United States",
                        "countryCode": "US"
        }
        ]
 }
 

We specifically want, for a city, 'locality', 'administrativeAreaCode', and 'countryCode'. Alternate entries, such as 'administrativeArea' and 'country' can be collected for searching, but are not necessary.
Now, of course, there's edge cases. Singapore, for example, has no 'locality'. Or 'administrativeAreaCode'.
So in that case, administrativeAreaCode can be nullable, but if 'locality' is not set, just use the country name.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PlaceResults.Coordinate	Represents a geographic coordinate.
static final record	PlaceResults.DisplayMapRegion	Represents a map region for display purposes.
static final record	PlaceResults.Place	Represents a place result from the geocoding API.
static final record	PlaceResults.StructuredAddress	Represents a structured address.

Constructor Summary

Constructors

Constructor	Description
PlaceResults(List<PlaceResults.Place> results)	Creates an instance of a PlaceResults record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<PlaceResults.Place>	results()	Returns the value of the results record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PlaceResults

public PlaceResults(List<PlaceResults.Place> results)

Creates an instance of a PlaceResults record class.

Parameters:

results - the value for the results record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

results

public List<PlaceResults.Place> results()

Returns the value of the results record component.

Returns:

the value of the results record component