net.motionintelligence.client.api.response

Class GeocodingResponse

java.lang.Object

net.motionintelligence.client.api.response.GeocodingResponse

All Implemented Interfaces:

Iterable<GeocodingResponse.Candidate>

public class GeocodingResponse
extends Object
implements Iterable<GeocodingResponse.Candidate>

Response of the ESRI geocoding REST service for a requested address. It is immutable with a private constructor since it is only meant to be created from the returned json object. Note: This is not the complete response from the REST service - only relevant information is captured, the remainder is discarded. Created by David on 17.07.2017.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GeocodingResponse.Candidate Geocoding candidate for a requested address.

Method Summary

Modifier and Type	Method and Description
static GeocodingResponse	createWithJson(GeocodingResponse response, String jsonString)
String	getCompleteJsonResponseAsString()
GeocodingResponse.Candidate	getRepresentativeCandidate()
DefaultTargetCoordinate	getRepresentativeGeocodeOfRequest()
boolean	isEmpty()
Iterator<GeocodingResponse.Candidate>	iterator()
String	toString() Pretty prints the GeocodingResponse, i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

createWithJson

public static GeocodingResponse createWithJson(GeocodingResponse response,
                                               String jsonString)

getCompleteJsonResponseAsString

public String getCompleteJsonResponseAsString()

Returns:

the complete JSON response as String

getRepresentativeGeocodeOfRequest

public DefaultTargetCoordinate getRepresentativeGeocodeOfRequest()

Returns:

the first (and thus best) candidate coordinates contained in this geocoding response.

Throws:

NoSuchElementException - when response contains no candidates

getRepresentativeCandidate

public GeocodingResponse.Candidate getRepresentativeCandidate()

Returns:

the first (and thus best) candidate contained in this geocoding response.

Throws:

NoSuchElementException - when response contains no candidates

toString

public String toString()

Pretty prints the GeocodingResponse, i.e. with indention and line breaks.

Overrides:

toString in class Object

Returns:

the pretty print String of the response

iterator

public Iterator<GeocodingResponse.Candidate> iterator()

Specified by:

iterator in interface Iterable<GeocodingResponse.Candidate>

isEmpty

public boolean isEmpty()

Returns:

true if empty; false otherwise