org.databene.benerator.gui.Setup 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 2008-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.benerator.gui;

import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.File;
import java.text.MessageFormat;
import java.util.Locale;

import org.databene.benerator.archetype.Archetype;
import org.databene.benerator.archetype.ArchetypeManager;
import org.databene.benerator.main.DBSnapshotTool;
import org.databene.commons.FileUtil;
import org.databene.commons.LocaleUtil;
import org.databene.commons.NullSafeComparator;
import org.databene.commons.StringUtil;
import org.databene.commons.SystemInfo;
import org.databene.commons.bean.ObservableBean;
import org.databene.commons.ui.I18NError;
import org.databene.jdbacl.JDBCDriverInfo;

/**
 * Assembles all data useful for creating benerator archetypes.

 * 

 * Created at 29.11.2008 22:44:12
 * @since 0.5.6
 * @author Volker Bergmann
 */

public class Setup implements ObservableBean {
	
	private static final long serialVersionUID = 3353941855988168161L;
	
	private static final String DEFAULT_PROJECT_NAME = "myproject";
	private static final String DEFAULT_GROUP_ID = "com.my";
	private static final String DEFAULT_PROJECT_VERSION = "1.0";

	private static final String DEFAULT_DB_DRIVER = "oracle.jdbc.driver.OracleDriver";

	private PropertyChangeSupport changeSupport;
	
	private String  projectName;
	private String  groupId;
	private String  version;
	private File    projectFolder;
	
	private Archetype archetype;
	
	private boolean eclipseProject;
	private boolean offline;
	private boolean overwrite;

	private String encoding;
	private String lineSeparator;

	private String locale;
	private String dataset;

	private JDBCDriverInfo jdbcDriverType;
	private String dbUrl;
	private String dbDriver;
	private String dbPassword;
	private String dbSchema;
	private String dbUser;
	
	private File dropScriptFile;
	private File createScriptFile;
	private String dbSnapshot;
	
	private MavenDependency[] dbDependencies;

	public Setup() {
		this.changeSupport = new PropertyChangeSupport(this);
		
		projectFolder = new File(SystemInfo.getCurrentDir());
		setProjectName(DEFAULT_PROJECT_NAME);
		setGroupId(DEFAULT_GROUP_ID);
		setVersion(DEFAULT_PROJECT_VERSION);
		eclipseProject = false;
		offline = false;
		overwrite = false;
		
		setEncoding(SystemInfo.getFileEncoding());
		setLineSeparator(SystemInfo.getLineSeparator());
		setLocale(Locale.getDefault().toString());
		setDataset(LocaleUtil.getDefaultCountryCode());

		String url = System.getenv("DEFAULT_DATABASE");
		if (!StringUtil.isEmpty(url)) {
			for (JDBCDriverInfo candidate : JDBCDriverInfo.getInstances()) {
				String prefix = candidate.getUrlPrefix();
				if (url.startsWith(prefix)) {
					setJdbcDriverType(candidate);
					break;
				}
			}
			if (jdbcDriverType == null)
				setJdbcDriverType(JDBCDriverInfo.HSQL);
		}
		setDbUrl(url);
		setDbDriver(DEFAULT_DB_DRIVER);
		setDbUser(SystemInfo.getUserName());
		setDbSnapshot("dbunit");
		this.dbDependencies = new MavenDependency[0]; // TODO v0.8 handle maven dependencies
		if (archetype == null)
			setArchetype(ArchetypeManager.getInstance().getDefaultArchetype());
	}

	public String getProjectName() {
		return projectName;
	}

	public void setProjectName(String projectName) {
		String oldName = this.projectName;
		this.projectName = projectName;
		changeSupport.firePropertyChange("projectName", oldName, this.projectName);
		// if user had no value or the same value before, update it
		if (this.dbSchema == null || NullSafeComparator.equals(oldName, this.dbUser))
			setDbUser(projectName);
	}

	public String getGroupId() {
		return groupId;
	}

	public void setGroupId(String groupId) {
		this.groupId = groupId;
	}

	public String getVersion() {
		return version;
	}

	public void setVersion(String version) {
		this.version = version;
	}

	public void setArchetype(Archetype archetype) {
		Archetype oldValue = this.archetype;
	    this.archetype = archetype;
		changeSupport.firePropertyChange("eclipseProject", oldValue, this.archetype);
    }

	public Archetype getArchetype() {
    	return archetype;
    }

	public boolean isEclipseProject() {
		return eclipseProject;
	}

	public void setEclipseProject(boolean eclipseProject) {
		boolean oldValue = this.eclipseProject;
		this.eclipseProject = eclipseProject;
		changeSupport.firePropertyChange("eclipseProject", oldValue, this.eclipseProject);
	}

	public boolean isOffline() {
		return offline;
	}

	public void setOffline(boolean offline) {
		this.offline = offline;
	}

	public boolean isOverwrite() {
		return overwrite;
	}

	public void setOverwrite(boolean overwrite) {
		this.overwrite = overwrite;
	}

	public File getProjectFolder() {
		return projectFolder;
	}

	public void setProjectFolder(File projectFolder) {
		File oldValue = this.projectFolder;
		this.projectFolder = projectFolder;
		changeSupport.firePropertyChange("projectFolder", oldValue, this.projectFolder);
		if (DEFAULT_PROJECT_NAME.equals(projectName))
			setProjectName(projectFolder.getName());
	}

	public String getEncoding() {
		return encoding;
	}

	public void setEncoding(String encoding) {
		String oldValue = this.encoding;
		this.encoding = encoding;
		changeSupport.firePropertyChange("encoding", oldValue, this.encoding);
	}

	public String getLineSeparator() {
		return lineSeparator;
	}

	public void setLineSeparator(String lineSeparator) {
		String oldValue = this.lineSeparator;
		this.lineSeparator = lineSeparator;
		changeSupport.firePropertyChange("lineSeparator", oldValue, this.lineSeparator);
	}

	public String getLocale() {
		return locale;
	}

	public void setLocale(String locale) {
		String oldValue = this.locale;
		this.locale = locale;
		changeSupport.firePropertyChange("locale", oldValue, this.locale);
	}

	public String getDataset() {
		return dataset;
	}

	public void setDataset(String dataset) {
		String oldValue = this.dataset;
		this.dataset = dataset;
		changeSupport.firePropertyChange("dataset", oldValue, this.dataset);
	}
	
	public boolean isDatabaseProject() {
    	return archetype.getId().endsWith("db");
    }

	public boolean isShopProject() {
    	return archetype.getId().endsWith("shopdb");
    }

	public JDBCDriverInfo getJdbcDriverType() {
    	return jdbcDriverType;
    }

	public void setJdbcDriverType(JDBCDriverInfo driver) {
		JDBCDriverInfo oldValue = this.jdbcDriverType;
    	this.jdbcDriverType = driver;
    	changeSupport.firePropertyChange("jdbcDriverType", oldValue, this.jdbcDriverType);
    	if (!NullSafeComparator.equals(oldValue, this.jdbcDriverType)) {
    		String urlPattern = driver.getUrlPattern();
			String db = driver.getDefaultDatabase();
			if (StringUtil.isEmpty(db))
				db = "";
			setDbUrl(MessageFormat.format(urlPattern, 
					"", driver.getDefaultPort(), db));
			setDbDriver(driver.getDriverClass());
			setDbUser(driver.getDefaultUser());
			setDbSchema(driver.getDefaultSchema());
    	}
    }

	public String getDbUrl() {
		return dbUrl;
	}

	public void setDbUrl(String dbUrl) {
		String oldValue = this.dbUrl;
		this.dbUrl = dbUrl;
		changeSupport.firePropertyChange("dbUrl", oldValue, this.dbUrl);
	}

	public String getDbDriver() {
		return dbDriver;
	}

	public void setDbDriver(String dbDriver) {
		String oldValue = this.dbDriver;
		this.dbDriver = dbDriver;
		changeSupport.firePropertyChange("dbDriver", oldValue, this.dbDriver);
	}

	public String getDbPassword() {
		return dbPassword;
	}

	public void setDbPassword(String dbPassword) {
		String oldValue = this.dbPassword;
		this.dbPassword = dbPassword;
		changeSupport.firePropertyChange("dbPassword", oldValue, this.dbPassword);
	}

	public String getDbSchema() {
		return dbSchema;
	}

	public void setDbSchema(String dbSchema) {
		String oldValue = this.dbSchema;
		this.dbSchema = dbSchema;
		changeSupport.firePropertyChange("dbSchema", oldValue, this.dbSchema);
	}

	public String getDbUser() {
		return dbUser;
	}

	public void setDbUser(String dbUser) {
		String oldValue = this.dbUser;
		this.dbUser = dbUser;
		changeSupport.firePropertyChange("dbUser", oldValue, this.dbUser);
		// if schema or password had no value or the same value before, update it
		if (this.dbSchema == null || NullSafeComparator.equals(oldValue, this.dbSchema))
			setDbSchema(dbUser);
		if (this.dbPassword == null || NullSafeComparator.equals(oldValue, this.dbPassword))
			setDbPassword(dbUser);
	}
	
	public File getDropScriptFile() {
    	return dropScriptFile;
    }

	public void setDropScriptFile(File dropScriptFile) {
    	this.dropScriptFile = dropScriptFile;
    }

	public File getCreateScriptFile() {
    	return createScriptFile;
    }

	public void setCreateScriptFile(File createScriptFile) {
    	this.createScriptFile = createScriptFile;
    }

	public MavenDependency[] getDbDependencies() {
		return dbDependencies;
	}

	public void setDbDependencies(MavenDependency[] dbDependencies) {
		this.dbDependencies = dbDependencies;
	}

	public String getDbSnapshot() {
		return dbSnapshot;
	}
	
	public void setDbSnapshot(String dbSnapshot) {
		this.dbSnapshot = dbSnapshot;
	}
	
	public String getDbSnapshotFile() {
		if (DBSnapshotTool.DBUNIT_FORMAT.equals(dbSnapshot))
			return "base.dbunit.xml";
		else if (DBSnapshotTool.SQL_FORMAT.equals(dbSnapshot))
			return "base.sql";
		else if (DBSnapshotTool.XLS_FORMAT.equals(dbSnapshot))
			return "base.xls";
		else
			return null;
	}
	
	@Override
	public void addPropertyChangeListener(PropertyChangeListener listener) {
		changeSupport.addPropertyChangeListener(listener);
	}

	@Override
	public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener) {
		changeSupport.addPropertyChangeListener(propertyName, listener);
	}

	@Override
	public void removePropertyChangeListener(PropertyChangeListener listener) {
		changeSupport.removePropertyChangeListener(listener);
	}

	@Override
	public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener) {
		changeSupport.removePropertyChangeListener(propertyName, listener);
	}

	public File projectFile(String filename) {
		File file = new File(getProjectFolder(), filename);
		if (!overwrite && file.exists())
			throw new I18NError("FileAlreadyExists", null, filename);
		return file;
	}

	public File subDirectory(String relativePath) {
		return new File(projectFolder, FileUtil.nativePath(relativePath));
	}

}