AbstractDBUpgrade.java

package org.codehaus.mojo.dbupgrade.generic;

import java.io.InputStream;
import java.sql.SQLException;

import org.codehaus.mojo.dbupgrade.DBUpgradeException;
import org.codehaus.mojo.dbupgrade.sqlexec.SQLExec;

/*
 * Copyright 2000-2010 The Apache Software Foundation
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

public abstract class AbstractDBUpgrade
    implements DBUpgrade
{

    /**
     * SQLExec wrapper to throw DBUpgradeException on error
     * @param sqlexec
     * @param istream
     * @throws DBUpgradeException
     */
    protected void executeSQL( SQLExec sqlexec, InputStream istream )
        throws DBUpgradeException
    {
        try
        {
            sqlexec.execute( istream );
        }
        catch ( SQLException e )
        {
            throw new DBUpgradeException( e.getMessage(), e );
        }
    }

    /**
     * SQLExec wrapper to throw DBUpgradeException on error
     * @param sqlexec
     * @param sqlString
     * @throws DBUpgradeException
     */
    protected void executeSQL( SQLExec sqlexec, String sqlString )
        throws DBUpgradeException
    {
        try
        {
            sqlexec.execute( sqlString );
        }
        catch ( SQLException e )
        {
            throw new DBUpgradeException( e.getMessage(), e );
        }
    }

    /**
     * Helper method to run a SQL resource file in the same package of a class with option to commit
     * @param sqlexec
     * @param clazz
     * @param name
     * @param commit
     * @throws DBUpgradeException
     */
    protected void executeSQL( SQLExec sqlexec, Class<?> clazz, String dialect, boolean commit )
        throws DBUpgradeException
    {
        String packageName = clazz.getPackage().getName().replace( ".", "/" );
        String resourceName = packageName + "/" + dialect;

        DBUpgradeUsingSQL dbupgrader = new DBUpgradeUsingSQL( resourceName );
        dbupgrader.upgradeDB( sqlexec, dialect );

        try
        {
            if ( commit )
            {
                sqlexec.commit();
            }
        }
        catch ( SQLException e )
        {
            throw new DBUpgradeException( "Unable to commit SQL works in resource: " + resourceName );
        }
    }

    /**
     * Helper method to run a SQL resource file in the same package of a class with option to commit
     * @param sqlexec
     * @param clazz
     * @param name
     * @param commit
     * @throws DBUpgradeException
     */
    protected void executeSQLNoParser( SQLExec sqlexec, Class<?> clazz, String dialect, boolean commit )
        throws DBUpgradeException
    {
        String packageName = clazz.getPackage().getName().replace( ".", "/" );
        String resourceName = packageName + "/" + dialect;

        DBUpgrade dbupgrader = new DBUpgradeUsingSQLNoParser( resourceName );
        dbupgrader.upgradeDB( sqlexec, dialect );

        try
        {
            if ( commit )
            {
                sqlexec.commit();
            }
        }
        catch ( SQLException e )
        {
            throw new DBUpgradeException( "Unable to commit SQL works in resource: " + resourceName );
        }
    }

}