com.ip2location.Region Maven / Gradle / Ivy

Go to download

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

IP2Location Java Component enables applications to get info from IP address such as the visitor’s country, region, city, latitude, longitude, ZIP code, ISP name, domain name, time zone, connection speed, IDD code, area code, weather station code, weather station name, MCC, MNC, mobile brand name, elevation, usage type, address type, IAB category, district, autonomous system number (ASN) and autonomous system (AS).

The newest version!

package com.ip2location;

import com.opencsv.*;
import com.opencsv.exceptions.*;

import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * This class parses region information CSV and returns the region code.
 * 
 * Copyright (c) 2002-2024 IP2Location.com
 * 
 *
 * @author IP2Location.com
 * @version 8.12.0
 */
public class Region {
    private final Map>> records = new HashMap<>();

    /**
     * This constructor reads the region information CSV and store the parsed info.
     *
     * @param CSVFile The full path to the region information CSV file.
     */
    public Region(String CSVFile) throws IOException, CsvValidationException {
        Map line;
        File file = new File(CSVFile);
        if (!file.exists()) {
            throw new IOException("The CSV file '" + CSVFile + "' is not found.");
        }
        FileReader fr = new FileReader(file);
        if (fr.read() == -1) {
            throw new IOException("Unable to read '" + CSVFile + "'.");
        }
        CSVReaderHeaderAware reader = new CSVReaderHeaderAware(new FileReader(file));
        while ((line = reader.readMap()) != null) {
            if (line.containsKey("subdivision_name")) {
                String cc = line.get("country_code");
                if (!records.containsKey(cc)) {
                    records.put(cc, new ArrayList<>());
                }
                Map item = new HashMap<>();
                item.put(line.get("subdivision_name").toUpperCase(), line.get("code"));
                records.get(cc).add(item);
            } else {
                throw new IOException("Invalid region information CSV file.");
            }
        }
    }

    /**
     * This function gets the region code for the supplied country code and region name.
     *
     * @param countryCode ISO-3166 country code
     * @param regionName  Region name
     * @return String     region code
     */
    public String getRegionCode(final String countryCode, final String regionName) throws IOException {
        if (records.isEmpty()) {
            throw new IOException("No record available.");
        } else {
            final List> items = records.get(countryCode);
            if (items == null) return null;

            final String region = regionName.toUpperCase();
            for (Map item : items) {
                final String regionCode = item.get(region);
                if (regionCode != null) return regionCode;
            }
        }
        return null;
    }

    /**
     * @deprecated Use {{@link #getRegionCode(String, String)} instead.
     */
    @Deprecated
    public String GetRegionCode(final String countryCode, final String regionName) throws IOException {
        return getRegionCode(countryCode, regionName);
    }
}