[Squirrel-sql-commits] sql12/plugins/dbdiff/src/net/sourceforge/squirrel_sql/plugins/dbdiff/prefs DBDiffPreferenceBean.java, NONE, 1.1 PreferencesManager.java, NONE, 1.1

[Rob M. <man...@us...>]

Update of /cvsroot/squirrel-sql/sql12/plugins/dbdiff/src/net/sourceforge/squirrel_sql/plugins/dbdiff/prefs
In directory sc8-pr-cvs8.sourceforge.net:/tmp/cvs-serv22631/plugins/dbdiff/src/net/sourceforge/squirrel_sql/plugins/dbdiff/prefs

Added Files:
	DBDiffPreferenceBean.java PreferencesManager.java 
Log Message:
Beginning of DBDiff plugin.

--- NEW FILE: PreferencesManager.java ---
/*
 * Copyright (C) 2005 Rob Manning
 * man...@us...
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package net.sourceforge.squirrel_sql.plugins.dbdiff.prefs;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Iterator;

import net.sourceforge.squirrel_sql.client.Version;
import net.sourceforge.squirrel_sql.client.plugin.IPlugin;
import net.sourceforge.squirrel_sql.client.plugin.PluginException;
import net.sourceforge.squirrel_sql.client.plugin.PreferenceUtil;
import net.sourceforge.squirrel_sql.fw.util.log.ILogger;
import net.sourceforge.squirrel_sql.fw.util.log.LoggerController;
import net.sourceforge.squirrel_sql.fw.xml.XMLBeanReader;
import net.sourceforge.squirrel_sql.fw.xml.XMLBeanWriter;

public class PreferencesManager {

    /** Logger for this class. */
    private final static ILogger s_log = 
        LoggerController.createLogger(PreferencesManager.class);
    
    /** Name of preferences file. */
    private static final String USER_PREFS_FILE_NAME = "prefs.xml";    
    
    /** Folder to store user settings in. */
    private static File _userSettingsFolder;
    
    private static DBDiffPreferenceBean _prefs = null;
    
    private static IPlugin plugin = null;
    
    public static void initialize(IPlugin thePlugin) throws PluginException {
        plugin = thePlugin;
        
        // Folder to store user settings.
        try {
            _userSettingsFolder = plugin.getPluginUserSettingsFolder();
        } catch (IOException ex) {
            throw new PluginException(ex);
        }        
        
        loadPrefs();
    }
    
    public static DBDiffPreferenceBean getPreferences() {
        return _prefs;
    }
    
    public static void unload() {
        savePrefs();
    }
    
    /**
     * Save preferences to disk.  Always write to the user settings folder, not
     * the application settings folder.
     */
    public static void savePrefs() {
        try {
            XMLBeanWriter wtr = new XMLBeanWriter(_prefs);
            wtr.save(new File(_userSettingsFolder, USER_PREFS_FILE_NAME));
        } catch (Exception ex) {
            s_log.error("Error occured writing to preferences file: "
                    + USER_PREFS_FILE_NAME, ex);
        }
    }

    /**
     * Load from preferences file.
     */
    private static void loadPrefs() {
        try {
            XMLBeanReader doc = new XMLBeanReader();
            
            File prefFile = PreferenceUtil.getPreferenceFileToReadFrom(plugin);
            
            doc.load(prefFile, DBDiffPreferenceBean.class.getClassLoader());
            
            Iterator it = doc.iterator();
            if (it.hasNext()) {
                _prefs = (DBDiffPreferenceBean)it.next();
            }
        } catch (FileNotFoundException ignore) {
            s_log.info(USER_PREFS_FILE_NAME + " not found - will be created");
        } catch (Exception ex) {
            s_log.error("Error occured reading from preferences file: "
                    + USER_PREFS_FILE_NAME, ex);
        }
        if (_prefs == null) {
            _prefs = new DBDiffPreferenceBean();
        }

        _prefs.setClientName(Version.getApplicationName() + "/" + plugin.getDescriptiveName());
        _prefs.setClientVersion(Version.getShortVersion() + "/" + plugin.getVersion());
    }    
    
    
}

--- NEW FILE: DBDiffPreferenceBean.java ---
package net.sourceforge.squirrel_sql.plugins.dbdiff.prefs;
/*
 * Copyright (C) 2005 Rob Manning
 * man...@us...
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
import java.io.Serializable;

/**
 * A bean class to store preferences for the DB Diff plugin.
 */
public class DBDiffPreferenceBean implements Cloneable, 
                                             Serializable {
	static final String UNSUPPORTED = "Unsupported";

    /** Client Name. */
	private String _clientName;

	/** Client version. */
	private String _clientVersion;

    /** whether or not to use a local file to stream bytes for copying blobs */
    private boolean useFileCaching = true;
    
    /** How many bytes to read/write at a time from memory to disk and back */
    private int fileCacheBufferSize = 8192;
    
    /** Use the truncate command instead of delete if the database supports it */
    private boolean useTruncate = true;
        
    /** whether or not commit after each statement on the destination connection */
    private boolean autoCommitEnabled = true;
    
    /** How many statements to issue before committing when auto-commit is off */
    private int commitCount = 100;
    
    /** whether or not to write each SQL executed to a script file */
    private boolean writeScript = false;
    
    /** whether or not to copy the records from the source to dest table */
    private boolean copyData = true;
    
    /** whether or not to copy the index definitions */
    private boolean copyIndexDefs = true;
    
    /** whether or not to copy the foreign keys */
    private boolean copyForeignKeys = true;
    
    /** whether or not to copy the primary keys */
    private boolean copyPrimaryKeys = true;
    
    /** whether or not to discard logically identical index defs */
    private boolean pruneDuplicateIndexDefs = true;
    
    /** whether or not to commit after issuing a create table statement */
    private boolean commitAfterTableDefs = true;
    
    /** whether to prompt the user for dest db dialect, or try to auto-detect */ 
    private boolean promptForDialect = false;
    
    /** whether or not to check column names in source db for keywords in dest */
    private boolean checkKeywords = true;
    
    /** whether or not to test column names in the destination database */
    private boolean testColumnNames = true;
        
    /** default number of records to retrieve from the database in selects */
    private int selectFetchSize = 1000;
    
    /** default for whether or not to delay between copying objects */
    private boolean delayBetweenObjects = false;
    
    /** default number of milliseconds to wait between copying tables */
    private long tableDelayMillis = 0;
    
    /** default number of milliseconds to wait between copying records */
    private long recordDelayMillis = 0;
    
	public DBDiffPreferenceBean() {
		super();
	}

	/**
	 * Return a copy of this object.
	 */
	public Object clone() {
		try {
			return super.clone();
		} catch (CloneNotSupportedException ex) {
			throw new InternalError(ex.getMessage()); // Impossible.
		}
	}

	/**
	 * Retrieve the client to use. This is only
	 * used if <TT>useAnonymousClient</TT> is false.
	 *
	 * @return	Client name.
	 */
	public String getClientName() {
		return _clientName;
	}

	/**
	 * Set the client name.
	 *
	 * @param	value	Client name
	 */
	public void setClientName(String value) {
		_clientName = value;
	}

	/**
	 * Retrieve the client version to use. This is only
	 * used if <TT>useAnonymousLogon</TT> is false.
	 *
	 * @return	Client version.
	 */
	public String getClientVersion() {
		return _clientVersion;
	}

	/**
	 * Set the client version.
	 *
	 * @param	value	Client version
	 */
	public void setClientVersion(String value) {
		_clientVersion = value;
	}

    /**
     * Sets whether or not to use a local file to stream bytes for copying blobs
     * @param useFileCaching The useFileCaching to set.
     */
    public void setUseFileCaching(boolean useFileCaching) {
        this.useFileCaching = useFileCaching;
    }

    /**
     * Returns a boolean value indicating whether or not to use a local file 
     * to stream bytes for copying blobs
     * 
     * @return Returns the useFileCaching.
     */
    public boolean isUseFileCaching() {
        return useFileCaching;
    }

    /**
     * @param fileCacheBufferSize The fileCacheBufferSize to set.
     */
    public void setFileCacheBufferSize(int fileCacheBufferSize) {
        this.fileCacheBufferSize = fileCacheBufferSize;
    }

    /**
     * @return Returns the fileCacheBufferSize.
     */
    public int getFileCacheBufferSize() {
        return fileCacheBufferSize;
    }

    /**
     * @param useTruncate The useTruncate to set.
     */
    public void setUseTruncate(boolean useTruncate) {
        this.useTruncate = useTruncate;
    }

    /**
     * @return Returns the useTruncate.
     */
    public boolean isUseTruncate() {
        return useTruncate;
    }

    /**
     * @param autoCommitEnabled The autoCommitEnabled to set.
     */
    public void setAutoCommitEnabled(boolean autoCommitEnabled) {
        this.autoCommitEnabled = autoCommitEnabled;
    }

    /**
     * @return Returns the autoCommitEnabled.
     */
    public boolean isAutoCommitEnabled() {
        return autoCommitEnabled;
    }

    /**
     * @param commitCount The commitCount to set.
     */
    public void setCommitCount(int commitCount) {
        this.commitCount = commitCount;
    }

    /**
     * @return Returns the commitCount.
     */
    public int getCommitCount() {
        return commitCount;
    }

    /**
     * @param writeScript The writeScript to set.
     */
    public void setWriteScript(boolean writeScript) {
        this.writeScript = writeScript;
    }

    /**
     * @return Returns the writeScript.
     */
    public boolean isWriteScript() {
        return writeScript;
    }

    /**
     * @param copyData The copyData to set.
     */
    public void setCopyData(boolean copyData) {
        this.copyData = copyData;
    }

    /**
     * @return Returns the copyData.
     */
    public boolean isCopyData() {
        return copyData;
    }

    /**
     * @param copyIndexDefs The copyIndexDefs to set.
     */
    public void setCopyIndexDefs(boolean copyIndexDefs) {
        this.copyIndexDefs = copyIndexDefs;
    }

    /**
     * @return Returns the copyIndexDefs.
     */
    public boolean isCopyIndexDefs() {
        return copyIndexDefs;
    }

    /**
     * @param copyForeignKeys The copyForeignKeys to set.
     */
    public void setCopyForeignKeys(boolean copyForeignKeys) {
        this.copyForeignKeys = copyForeignKeys;
    }

    /**
     * @return Returns the copyForeignKeys.
     */
    public boolean isCopyForeignKeys() {
        return copyForeignKeys;
    }

    /**
     * @param pruneDuplicateIndexDefs The pruneDuplicateIndexDefs to set.
     */
    public void setPruneDuplicateIndexDefs(boolean pruneDuplicateIndexDefs) {
        this.pruneDuplicateIndexDefs = pruneDuplicateIndexDefs;
    }

    /**
     * @return Returns the pruneDuplicateIndexDefs.
     */
    public boolean isPruneDuplicateIndexDefs() {
        return pruneDuplicateIndexDefs;
    }

    /**
     * @param commitAfterTableDefs The commitAfterTableDefs to set.
     */
    public void setCommitAfterTableDefs(boolean commitAfterTableDefs) {
        this.commitAfterTableDefs = commitAfterTableDefs;
    }

    /**
     * @return Returns the commitAfterTableDefs.
     */
    public boolean isCommitAfterTableDefs() {
        return commitAfterTableDefs;
    }

    /**
     * @param promptForDialect The promptForDialect to set.
     */
    public void setPromptForDialect(boolean promptForDialect) {
        this.promptForDialect = promptForDialect;
    }

    /**
     * @return Returns the promptForDialect.
     */
    public boolean isPromptForDialect() {
        return promptForDialect;
    }

    /**
     * @param checkKeywords The checkKeywords to set.
     */
    public void setCheckKeywords(boolean checkKeywords) {
        this.checkKeywords = checkKeywords;
    }

    /**
     * @return Returns the checkKeywords.
     */
    public boolean isCheckKeywords() {
        return checkKeywords;
    }

    /**
     * @param testColumnNames The testColumnNames to set.
     */
    public void setTestColumnNames(boolean testColumnNames) {
        this.testColumnNames = testColumnNames;
    }

    /**
     * @return Returns the testColumnNames.
     */
    public boolean isTestColumnNames() {
        return testColumnNames;
    }

    /**
     * @param copyPrimaryKeys The copyPrimaryKeys to set.
     */
    public void setCopyPrimaryKeys(boolean copyPrimaryKeys) {
        this.copyPrimaryKeys = copyPrimaryKeys;
    }

    /**
     * @return Returns the copyPrimaryKeys.
     */
    public boolean isCopyPrimaryKeys() {
        return copyPrimaryKeys;
    }

    /**
     * @param selectFetchSize The selectFetchSize to set.
     */
    public void setSelectFetchSize(int selectFetchSize) {
        this.selectFetchSize = selectFetchSize;
    }

    /**
     * @return Returns the selectFetchSize.
     */
    public int getSelectFetchSize() {
        return selectFetchSize;
    }

    /**
     * @param tableDelayMillis The tableDelayMillis to set.
     */
    public void setTableDelayMillis(long tableDelayMillis) {
        this.tableDelayMillis = tableDelayMillis;
    }

    /**
     * @return Returns the tableDelayMillis.
     */
    public long getTableDelayMillis() {
        return tableDelayMillis;
    }

    /**
     * @param recordDelayMillis The recordDelayMillis to set.
     */
    public void setRecordDelayMillis(long recordDelayMillis) {
        this.recordDelayMillis = recordDelayMillis;
    }

    /**
     * @return Returns the recordDelayMillis.
     */
    public long getRecordDelayMillis() {
        return recordDelayMillis;
    }

    /**
     * @param delayBetweenObjects The delayBetweenObjects to set.
     */
    public void setDelayBetweenObjects(boolean delayBetweenObjects) {
        this.delayBetweenObjects = delayBetweenObjects;
    }

    /**
     * @return Returns the delayBetweenObjects.
     */
    public boolean isDelayBetweenObjects() {
        return delayBetweenObjects;
    }
 
}