tri.area.JhuAreaData.kt Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * coda-data
 * --
 * Copyright (C) 2020 - 2021 Elisha Peterson
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package tri.area

import com.fasterxml.jackson.annotation.JsonProperty
import tri.util.csvResource

/** Loads JHU region/population data. */
object JhuAreaData {
    private val data = JhuAreaData::class.csvResource(true, "resources/jhucsse/jhu-iso-fips-lookup.csv")

    val index = data.groupByOne { it.indexKey }
    val areas = index.values
    val usCounties = data.filter { Usa.validCountyFips(it.fips) }.map { it.fips!! to it }.toMap()

    private val lowerIndex by lazy { index.mapKeys { it.key.toString().toLowerCase() } }

    /** Looks up area by name, case-insensitive. */
    fun lookupCaseInsensitive(key: Any) = index.getOrElse(key) { lowerIndex[key.toString().trim().toLowerCase()] }
}

/** Data structure provided by JHU region data. */
data class JhuAreaInfo(val UID: Int, val iso2: String, val iso3: String, var code3: Int,
                       @JsonProperty("FIPS") val fips: Int? = null, @JsonProperty("Admin2") val admin2: String,
                       @JsonProperty("Province_State") val provinceOrState: String, @JsonProperty("Country_Region") val countryOrRegion: String,
                       @JsonProperty("Lat") val latitude: Float, @JsonProperty("Long_") val longitude: Float,
                       @JsonProperty("Combined_Key") val combinedKey: String, @JsonProperty("Population") val population: Long) {

    /** Get unique key used to lookup this region. Regions with FIPS have more than one possible key. */
    val indexKey: List
        get() = when {
            fips == null -> listOf(combinedKey)
            fips < 100 -> listOf(fips, Usa.abbreviationsByState[provinceOrState]!!)
            else -> listOf(fips, combinedKey)
        }

    val regionType
        get() = when {
            admin2.isEmpty() && provinceOrState.isEmpty() -> AreaType.COUNTRY_REGION
            provinceOrState.isEmpty() -> AreaType.METRO
            admin2.isEmpty() -> AreaType.PROVINCE_STATE
            else -> AreaType.COUNTY
        }

    val regionParent
        get() = when {
            admin2.isEmpty() && provinceOrState.isEmpty() -> EARTH
            provinceOrState.isEmpty() || admin2.isEmpty() -> Lookup.areaOrNull(countryOrRegion)!!
            else -> Lookup.areaOrNull("$provinceOrState, $countryOrRegion")!!
        }

    /** Convert to general area info object. */
    fun toAreaInfo(): AreaInfo {
        require(fips == null || fips >= 80000) { "Use Usa object to access areas within the US: $this" }
        return AreaInfo(combinedKey, regionType, regionParent, fips, AreaMetrics(population, latitude, longitude))
    }
}

//region UTILS

private fun  List.groupByOne(keySelectors: (X) -> List): Map {
    val res = mutableMapOf>()
    for (element in this) {
        keySelectors(element).forEach { key ->
            val list = res.getOrPut(key) { ArrayList() }
            list.add(element)
        }
    }
    res.values.forEach { if (it.size > 1) println("Two values had the same key: $it") }
    return res.mapValues { it.value.first() }
}

//endregion