com.targomo.client.api.response.esri.Candidate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Java client library for easy usage of Targomo web services.

There is a newer version: 0.39.0

package com.targomo.client.api.response.esri;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.targomo.client.api.geo.DefaultTargetCoordinate;

/**
 * Geocoding candidate for a requested address. It is immutable with a private constructor since it is only
 * meant to be created from a json object (as a REST response).
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class Candidate {
    private final double score;
    private final DefaultTargetCoordinate location;

    @JsonCreator
    public Candidate(@JsonProperty("score") double score, @JsonProperty("location") DefaultTargetCoordinate location){
        this.score = score;
        this.location = location;
    }

    /**
     * Return the Score of the candidate. The higher the score the more confidence into the candidate as the correct
     * representative. Maximum score is 100.0; Minimum 0.0.
     *
     * @return the score of the candidate
     */
    public double getScore() {
        return this.score;
    }

    /**
     * Returns the geocode as {@link DefaultTargetCoordinate} according to the spatial reference from the request.
     * Default reference is "EPSG 4326" (.i.e. if not otherwise specified)
     * @return the geo location of the candidate
     */
    public DefaultTargetCoordinate getLocation(){
        return this.location;
    }
}