org.databene.domain.address.CityManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of databene-benerator Show documentation
benerator is a framework for creating realistic and valid high-volume test data, used for testing (unit/integration/load) and showcase setup. Metadata constraints are imported from systems and/or configuration files. Data can imported from and exported to files and systems, anonymized or generated from scratch. Domain packages provide reusable generators for creating domain-specific data as names and addresses internationalizable in language and region. It is strongly customizable with plugins and configuration options.
The newest version!
/*
 * (c) Copyright 2007-2012 by Volker Bergmann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted under the terms of the
 * GNU General Public License.
 *
 * For redistributing this software or a derivative work under a license other
 * than the GPL-compatible Free Software License as defined by the Free
 * Software Foundation or approved by OSI, you must first obtain a commercial
 * license to this software product from Volker Bergmann.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
 * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
 * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package org.databene.domain.address;

import org.databene.formats.DataContainer;
import org.databene.formats.csv.BeanCSVWriter;
import org.databene.formats.csv.CSVLineIterator;
import org.databene.commons.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.*;
import java.util.concurrent.atomic.AtomicInteger;
import java.io.IOException;
import java.io.FileWriter;

/**
 * Reads and persists city files in CSV format (column header = property name).

 * 

 * Created: 28.07.2007 15:21:12
 * @author Volker Bergmann
 */
public class CityManager {

    private static final Logger LOGGER = LoggerFactory.getLogger(CityManager.class);
    
    public static void readCities(Country country) {
        String filename = "/org/databene/domain/address/city_" + country.getIsoCode() + ".csv";
        if (IOUtil.isURIAvailable(filename))
            readCities(country, filename, new HashMap());
        else
        	LOGGER.warn("File not found: " + filename);
    }

    public static void readCities(Country country, String filename, Map defaults) {
    	try {
	        int warnCount = parseCityFile(country, filename, defaults);
	        if (warnCount > 0)
	            LOGGER.warn(warnCount + " warnings");
    	} catch (IOException e) {
    		throw new ConfigurationError("Error reading cities file: " + filename, e);
    	}
    }

	private static int parseCityFile(Country country, String filename, Map defaults) throws IOException {
		LOGGER.debug("Parsing city definitions in file {}", filename);
		CSVLineIterator iterator = new CSVLineIterator(filename, ';', Encodings.UTF_8);
		DataContainer container = new DataContainer();
        String[] header = iterator.next(container).getData();
        AtomicInteger warnCount = new AtomicInteger();
        while ((container = iterator.next(container)) != null) {
            String[] cells = container.getData();
            if (cells.length == 0)
                continue;
            if (LOGGER.isDebugEnabled())
                LOGGER.debug(ArrayFormat.format(";", cells));
            if (cells.length == 1)
                continue;
            Map instance = new HashMap();
            for (int i = 0; i < cells.length; i++)
                instance.put(header[i], cells[i]);
            LOGGER.debug("{}", instance);

            String stateId = instance.get("state.id");
            String stateName = instance.get("state.name");
            State state = getOrCreateState(stateId, stateName, country);

			int lineNumber = iterator.lineCount();
            CityId cityId = createCityId(instance, lineNumber);
            getOrCreateCity(cityId, state, instance, defaults, warnCount);
        }
		return warnCount.get();
	}

	private static State getOrCreateState(String stateId, String stateName,
			Country country) {
		State state = country.getState(stateId);
		if (state == null) {
		    state = new State(stateId);
			if (stateName != null)
		    	state.setName(StringUtil.normalizeName(stateName));
			//logger.debug(state.getId() + "," + state.getName());
		    country.addState(state);
		}
		return state;
	}

	protected static CityId createCityId(Map instance,
			int lineNumber) {
		CityId cityId;
		if (!StringUtil.isEmpty(instance.get("municipality")))
			cityId = new CityId(instance.get("municipality"), null);
		else if (!StringUtil.isEmpty(instance.get("city")))
		    cityId = new CityId(instance.get("city"), null);
		else if (!StringUtil.isEmpty(instance.get("name"))) {
		    String cityName = instance.get("name");
		    String cityNameExtension = instance.get("nameExtension");
		    cityId = new CityId(cityName, cityNameExtension);
		} else
			throw new ParseException("Unable to parse city", instance.toString(), lineNumber, 1);
		return cityId;
	}

	private static CityHelper getOrCreateCity(CityId cityId, State state, Map instance, Map defaults, AtomicInteger warnCount) {
        // create/setup city
        CityHelper city = (CityHelper) state.getCity(cityId);
        String postalCode = instance.get("postalCode");
        String lang = getValue(instance, "language", defaults);
        if (city == null) {
            String areaCode = getValue(instance, "areaCode", defaults);
            if (StringUtil.isEmpty(areaCode)) {
                warnCount.incrementAndGet();
                LOGGER.warn("areaCode is not provided for city: '" + cityId);
            }
            city = new CityHelper(state, cityId, new String[] { postalCode }, areaCode);
            if (!StringUtil.isEmpty(lang))
            	city.setLanguage(LocaleUtil.getLocale(lang));
            state.addCity(cityId, city);
        } else
            city.addPostalCode(postalCode);
        return city;
	}

    public static void persistCities(Country country, String filename) throws IOException {
        // persist city data in standard format
        BeanCSVWriter writer = new BeanCSVWriter(new FileWriter(filename), ';',
                "state.country.isoCode", "state.id", "name", "nameExtension",
                "zipCode", "areaCode", "language");
        for (State state : country.getStates()) {
            for (City city : state.getCities())
                for (String zipCode : city.getPostalCodes()) {
                    ((CityHelper)city).setPostalCode(zipCode);
                    writer.writeElement(city);
                }
        }
        writer.close();
    }

    // private helpers -------------------------------------------------------------------------------------------------

    private static String getValue(Map instance, String key, Map defaults) {
        String value = instance.get(key);
        if (value == null)
            value = defaults.get(key);
        return value;
    }

    public static class CityHelper extends City {

        private String postalCode;

        public CityHelper(State state, CityId cityId, String[] zipCodes, String areaCode) {
            super(state, cityId.getName(), cityId.getNameExtension(), zipCodes, areaCode);
        }

        public String getPostalCode() {
            return postalCode;
        }

        public void setPostalCode(String postalCode) {
            this.postalCode = postalCode;
        }
    }

}