org.databene.domain.address.StreetNameGenerator 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-2013 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 java.util.Locale;
import java.util.Stack;

import org.databene.benerator.Generator;
import org.databene.benerator.GeneratorContext;
import org.databene.benerator.NonNullGenerator;
import org.databene.benerator.csv.WeightedDatasetCSVGenerator;
import org.databene.benerator.dataset.DatasetBasedGenerator;
import org.databene.benerator.dataset.DatasetUtil;
import org.databene.benerator.util.GeneratorUtil;
import org.databene.benerator.wrapper.GeneratorProxy;
import org.databene.commons.ConfigurationError;
import org.databene.commons.Encodings;
import org.databene.commons.StringUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Generates a street name for a region.

 * 

 * Created: 12.06.2006 00:08:28
 * @since 0.1
 * @author Volker Bergmann
 */
public class StreetNameGenerator extends GeneratorProxy implements DatasetBasedGenerator, NonNullGenerator {
	
	private static final Logger LOGGER = LoggerFactory.getLogger(StreetNameGenerator.class);

    private static final String REGION_NESTING = "org/databene/dataset/region";
    private static final String FILENAME_PATTERN = "/org/databene/domain/address/street_{0}.csv";
    
    private String datasetName;

    // construction ----------------------------------------------------------------------------------------------------
    
    public StreetNameGenerator() {
    	this(null);
    }

    public StreetNameGenerator(String datasetName) {
        super(String.class);
        this.datasetName = datasetName;
    }
    
	// DatasetBasedGenerator interface implementation ------------------------------------------------------------------
	
	@Override
	public String getNesting() {
		return REGION_NESTING;
	}

	@Override
	public String getDataset() {
		return datasetName;
	}

	public void setDataset(String datasetName) {
		this.datasetName = datasetName;
	}

	@Override
	public String generateForDataset(String dataset) {
		return getSource().generateForDataset(dataset);
	}

    @Override
    public synchronized void init(GeneratorContext context) {
    	Stack datasetOptions = new Stack();
    	datasetOptions.push(DatasetUtil.fallbackRegionName());
    	datasetOptions.push(DatasetUtil.defaultRegionName());
    	if (!StringUtil.isEmpty(datasetName))
    		datasetOptions.push(datasetName);
    	init(datasetOptions, context);
    }

	private void init(Stack datasetOptions, GeneratorContext context) {
		String currentOption = datasetOptions.pop();
    	try {
			setSource(createSource(currentOption));
	        super.init(context);
    	} catch (Exception e) {
    		// if the call fails, try another option
    		if (datasetOptions.isEmpty())
        		throw new ConfigurationError(getClass().getSimpleName() + " could not be initialized");
    		String nextOption = datasetOptions.peek();
    		LOGGER.error("Error initializing " + getClass().getSimpleName() + " with dataset '" + currentOption + "': " + 
    				e.getMessage() + ". Falling back to '" + nextOption + "'");
			init(datasetOptions, context);
    	}
	}
    
	@Override
	public WeightedDatasetCSVGenerator getSource() {
		return (WeightedDatasetCSVGenerator) super.getSource();
	}
	
	@Override
	public String generate() {
		return GeneratorUtil.generateNonNull(this);
	}

	public String generateForCountryAndLocale(String countryCode, Locale language) {
		WeightedDatasetCSVGenerator source = getSource();
		String subset = countryCode + '_' + language.getLanguage();
		if (source.supportsDataset(subset))
			return source.generateForDataset(subset);
		subset = countryCode;
		return source.generateForDataset(countryCode);
	}
	
	// helpers ---------------------------------------------------------------------------------------------------------
	
	private static Generator createSource(String datasetName) {
	    return new WeightedDatasetCSVGenerator(String.class, FILENAME_PATTERN, datasetName, REGION_NESTING, true, Encodings.UTF_8);
    }

}