com.fgm.SQLScriptRunner

Class SQLScriptRunner

java.lang.Object

com.fgm.SQLScriptRunner.SQLScriptRunner

public class SQLScriptRunner
extends java.lang.Object

Tool to run database scripts. Slightly modified version of the com.ibatis.common.jdbc.ScriptRunner class from the iBATIS Apache project. Only removed dependency on Resource class and a constructor

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	autoCommit The auto commit.
private java.sql.Connection	connection The connection.
private static java.lang.String	DEFAULT_DELIMITER The Constant DEFAULT_DELIMITER.
private java.lang.String	delimiter The delimiter.
private java.io.PrintWriter	errorLogWriter The error log writer.
private boolean	fullLineDelimiter The full line delimiter.
protected org.apache.log4j.Logger	logger The logger.
private java.io.PrintWriter	logWriter The log writer.
private boolean	stopOnError The stop on error.

Constructor Summary

Constructors

Constructor and Description
SQLScriptRunner(java.sql.Connection connection, boolean autoCommit, boolean stopOnError) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private void	flush() Flush the logger and the error logger.
private java.lang.String	getDelimiter() Gets the delimiter.
private java.lang.String	getSpecialDelimiter() Gets the special delimiter.
static void	main(java.lang.String[] args) The main method.
private void	print(java.lang.Object o) Prints the object to the logger if it can.
private void	println(java.lang.Object o) Prints the object to the logger if it can.
private void	printlnError(java.lang.Object o) Prints the object to the error logger if it can.
private void	runScript(java.sql.Connection conn, java.io.Reader reader) Runs an SQL script (read in using the Reader parameter) using the connection passed in.
void	runScript(java.io.Reader reader) Runs an SQL script (read in using the Reader parameter).
void	setDelimiter(java.lang.String delimiter, boolean fullLineDelimiter) Sets the delimiter.
void	setErrorLogWriter(java.io.PrintWriter errorLogWriter) Setter for errorLogWriter property.
void	setLogWriter(java.io.PrintWriter logWriter) Setter for logWriter property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_DELIMITER

private static final java.lang.String DEFAULT_DELIMITER

The Constant DEFAULT_DELIMITER.

See Also:

Constant Field Values

connection

private java.sql.Connection connection

The connection.

stopOnError

private boolean stopOnError

The stop on error.

autoCommit

private boolean autoCommit

The auto commit.

logWriter

private java.io.PrintWriter logWriter

The log writer.

errorLogWriter

private java.io.PrintWriter errorLogWriter

The error log writer.

delimiter

private java.lang.String delimiter

The delimiter.

fullLineDelimiter

private boolean fullLineDelimiter

The full line delimiter.

logger

protected org.apache.log4j.Logger logger

The logger.

Constructor Detail

SQLScriptRunner

public SQLScriptRunner(java.sql.Connection connection,
               boolean autoCommit,
               boolean stopOnError)

Default constructor.

Parameters:

connection - the connection

autoCommit - the auto commit

stopOnError - the stop on error

Method Detail

setDelimiter

public void setDelimiter(java.lang.String delimiter,
                boolean fullLineDelimiter)

Sets the delimiter.

Parameters:

delimiter - the delimiter

fullLineDelimiter - the full line delimiter

setLogWriter

public void setLogWriter(java.io.PrintWriter logWriter)

Setter for logWriter property.

Parameters:

logWriter - - the new value of the logWriter property

setErrorLogWriter

public void setErrorLogWriter(java.io.PrintWriter errorLogWriter)

Setter for errorLogWriter property.

Parameters:

errorLogWriter - - the new value of the errorLogWriter property

runScript

public void runScript(java.io.Reader reader)
               throws java.io.IOException,
                      java.sql.SQLException

Runs an SQL script (read in using the Reader parameter).

Parameters:

reader - - the source of the script

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

java.sql.SQLException - the SQL exception

runScript

private void runScript(java.sql.Connection conn,
             java.io.Reader reader)
                throws java.io.IOException,
                       java.sql.SQLException

Runs an SQL script (read in using the Reader parameter) using the connection passed in.

Parameters:

conn - - the connection to use for the script

reader - - the source of the script

Throws:

java.io.IOException - if there is an error reading from the Reader

java.sql.SQLException - if any SQL errors occur

getDelimiter

private java.lang.String getDelimiter()

Gets the delimiter.

Returns:

the delimiter

getSpecialDelimiter

private java.lang.String getSpecialDelimiter()

Gets the special delimiter.

Returns:

the special delimiter

print

private void print(java.lang.Object o)

Prints the object to the logger if it can. Otherwise to System.out

Parameters:

o - the Object

println

private void println(java.lang.Object o)

Prints the object to the logger if it can. Otherwise to System.out

Parameters:

o - the Object

printlnError

private void printlnError(java.lang.Object o)

Prints the object to the error logger if it can. Otherwise to System.out

Parameters:

o - the Object

flush

private void flush()

Flush the logger and the error logger.

main

public static void main(java.lang.String[] args)

The main method. For debugging only

Parameters:

args - the arguments