com.sibvisions.util.db
Class DBImporter

java.lang.Object
  com.sibvisions.util.db.DBImporter

public class DBImporter
extends java.lang.Object

The DBImporter executes DML or DDL statements. The statemens are read from simple text files. Use an empty line or a semicolon to separate statements. Use //, # or -- to comment single lines. A comment line is completly ignored. It allows simple scripting like:

 ${VAR1} = select max(id) from table
 
 insert into detail(id, name, table_id) values (1, 'JVx', ${VAR1})
 

Use custom commands to extend the standard calls:

 insert into table(name, creation) values ('JVx', executeTime())
 

The above command executeTime is mapped to ExecuteTimeCommand.

Nested Class Summary

protected static class

DBImporter.DBStatement The DBStatement is a simple POJO that stores the statement (with or without wildcards) and the parameters, if available.

Constructor Summary

DBImporter()

Method Summary

protected DBImporter.DBStatement	createDBStatement(java.lang.String pStatement) Creates a statement and parses the parameters.
boolean	execute(java.sql.Connection pConnection, java.io.InputStream pInput) Reads the statements from a stream and executes each statement.
java.lang.Exception[]	getExceptions() Gets the last occured exception(s).
java.lang.String	getFileEncoding() Gets the file-encoding charset name.
java.lang.Object	getParameter(java.lang.String pParameter) Gets the value of a user-defined parameter.
boolean	isCancelOnFailure() Gets whether the script execution should be stopped if an error occurs.
boolean	isParameterSet(java.lang.String pParameter) Gets whether a parameter is set.
java.util.List<DBImporter.DBStatement>	list(java.io.InputStream pInput) Gets all statements from the given stream.
void	setCancelOnFailure(boolean pCancel) Sets whether the complete script should be executed independent of errors.
void	setFileEncoding(java.lang.String pEncoding) Sets the file-encoding charset name.
void	setParameter(java.lang.String pParameter, java.lang.Object pValue) Sets a user-defined parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBImporter

public DBImporter()

Method Detail

list

public java.util.List<DBImporter.DBStatement> list(java.io.InputStream pInput)
                                            throws java.lang.Exception

Gets all statements from the given stream.

Parameters:

pInput - the stream with statements

Returns:

the list of found statements

Throws:

java.lang.Exception - if statement parsing fails

execute

public boolean execute(java.sql.Connection pConnection,
                       java.io.InputStream pInput)
                throws java.lang.Exception

Reads the statements from a stream and executes each statement.

Parameters:

pConnection - the database connection

pInput - the statement stream

Returns:

true if executions was successful, false if an error occured and setCancelOnFailure(boolean) is enabled

Throws:

java.lang.Exception - if execution of a statement failed and setCancelOnFailure(boolean) is disabled

createDBStatement

protected DBImporter.DBStatement createDBStatement(java.lang.String pStatement)
                                            throws java.lang.Exception

Creates a statement and parses the parameters.

Parameters:

pStatement - the complete statement

Returns:

the statement with parameter syntax

Throws:

java.lang.Exception - if parameter detection fails

setCancelOnFailure

public void setCancelOnFailure(boolean pCancel)

Sets whether the complete script should be executed independent of errors.

Parameters:

pCancel - true to ignore exceptions during execution, false to throw exceptions immediate and stop execution

See Also:

getExceptions()

isCancelOnFailure

public boolean isCancelOnFailure()

Gets whether the script execution should be stopped if an error occurs.

Returns:

true if execution is stopped after the first exception, false to collect exceptions

See Also:

getExceptions()

getExceptions

public java.lang.Exception[] getExceptions()

Gets the last occured exception(s).

Returns:

the execution exception(s)

See Also:

setCancelOnFailure(boolean)

setParameter

public void setParameter(java.lang.String pParameter,
                         java.lang.Object pValue)

Sets a user-defined parameter.

Parameters:

pParameter - the parameter name

pValue - the value

getParameter

public java.lang.Object getParameter(java.lang.String pParameter)

Gets the value of a user-defined parameter.

Parameters:

pParameter - the parameter name

Returns:

the value. null is possible if the value is not set or the value itself is null. isParameterSet(String)

isParameterSet

public boolean isParameterSet(java.lang.String pParameter)

Gets whether a parameter is set. This methods helps to find out if the value of a parameter is null or the parameter is not set.

Parameters:

pParameter - the parameter name

Returns:

true if the parameter is set, false if the parameter is not available

setFileEncoding

public void setFileEncoding(java.lang.String pEncoding)

Sets the file-encoding charset name.

Parameters:

pEncoding - the charset name

getFileEncoding

public java.lang.String getFileEncoding()

Gets the file-encoding charset name.

Returns:

the charset name or null if undefined (= system file encoding)