com.maxmind.geoip2.record.Location Maven / Gradle / Ivy

Go to download
package com.maxmind.geoip2.record;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.maxmind.db.MaxMindDbConstructor;
import com.maxmind.db.MaxMindDbParameter;

/**
 * 
 * Contains data for the location record associated with an IP address.
 * 
 */
public class Location extends AbstractRecord {

    private final Integer accuracyRadius;
    private final Integer averageIncome;
    private final Double latitude;
    private final Double longitude;
    private final Integer metroCode;
    private final Integer populationDensity;
    private final String timeZone;

    public Location() {
        this(null, null, null, null, null, null, null);
    }

    @MaxMindDbConstructor
    public Location(
        @JsonProperty("accuracy_radius") @MaxMindDbParameter(name = "accuracy_radius")
        Integer accuracyRadius,
        @JsonProperty("average_income") @MaxMindDbParameter(name = "average_income")
        Integer averageIncome,
        @JsonProperty("latitude") @MaxMindDbParameter(name = "latitude") Double latitude,
        @JsonProperty("longitude") @MaxMindDbParameter(name = "longitude") Double longitude,
        @JsonProperty("metro_code") @MaxMindDbParameter(name = "metro_code") Integer metroCode,
        @JsonProperty("population_density") @MaxMindDbParameter(name = "population_density")
        Integer populationDensity,
        @JsonProperty("time_zone") @MaxMindDbParameter(name = "time_zone") String timeZone
    ) {
        this.accuracyRadius = accuracyRadius;
        this.averageIncome = averageIncome;
        this.latitude = latitude;
        this.longitude = longitude;
        this.metroCode = metroCode;
        this.populationDensity = populationDensity;
        this.timeZone = timeZone;
    }

    /**
     * @return The average income in US dollars associated with the requested
     * IP address. This attribute is only available from the Insights web
     * service.
     */
    @JsonProperty("average_income")
    public Integer getAverageIncome() {
        return this.averageIncome;
    }

    /**
     * @return The estimated population per square kilometer associated with the
     * IP address. This attribute is only available from the Insights web
     * service.
     */
    @JsonProperty("population_density")
    public Integer getPopulationDensity() {
        return this.populationDensity;
    }

    /**
     * @return The time zone associated with location, as specified by the IANA Time Zone
     * Database, e.g., "America/New_York".
     */
    @JsonProperty("time_zone")
    public String getTimeZone() {
        return this.timeZone;
    }

    /**
     * @return The approximate accuracy radius in kilometers around the
     * latitude and longitude for the IP address. This is the radius where we
     * have a 67% confidence that the device using the IP address resides
     * within the circle centered at the latitude and longitude with the
     * provided radius.
     */
    @JsonProperty("accuracy_radius")
    public Integer getAccuracyRadius() {
        return this.accuracyRadius;
    }

    /**
     * @return The metro code of the location if the location is in the US.
     * MaxMind returns the same metro codes as the Google AdWords API.
     */
    @JsonProperty("metro_code")
    public Integer getMetroCode() {
        return this.metroCode;
    }

    /**
     * @return The approximate latitude of the location associated with the
     * IP address. This value is not precise and should not be used to
     * identify a particular address or household.
     */
    public Double getLatitude() {
        return this.latitude;
    }

    /**
     * @return The approximate longitude of the location associated with the
     * IP address. This value is not precise and should not be used to
     * identify a particular address or household.
     */
    public Double getLongitude() {
        return this.longitude;
    }
}