SQLProcessor (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.admin.sql.SQLProcessor

```
public class SQLProcessor
extends Object
```
The SQLProcessor class preprocesses and executes SQL script files.

Version:

1.7

Author:

Edmund Chui, Luis Saenz

(Unpublished)

Modified:

dlong 04/12/2018 ECMSDK-427: Fix parser to recognize symbol at the end of the line., dlong 04/12/2017 ECMSDK-239: Set autocommit off on new connection., sgarg 02/24/2002 Enhanced the handling of "WHENEVER", sgarg 05/16/2001 Modifed scanKeyword to handle whitespaces., lsaenz 03/23/2001 Changed symbol substitution to handle dot tokens just after &VAR tokens; no longer using SymbolCommuter., lsaenz 07/18/2000 Fixed language-dependent concatenation., lsaenz 07/06/2000 Changed to use Log; made logging optional., lsaenz 02/14/2000 Removed calls which required native support in OsUtils; unused and unecessary., lsaenz 02/06/2000 Added import statements for subpackages of oracle.ifs.utils., lsaenz 12/03/1999 Hacked to ignore "WHENEVER" command., lsaenz 12/02/1999 Now uses OracleConnections rather than OracleConnectionFactory., lsaenz 11/07/1999 Removed all instantiate methods; now uses SymbolCommuter to do symbol substitution in expandLine()., lsaenz 09/23/1999 Made executeSQLFile() execute any remaining SQL in the SQL buffer after the end of file is reached in EVERY file pushed onto the InputStack, not just at the end of the last file., lsaenz 09/22/1999 Fixed bug in scanKeyword(), added one more PL/SQL type (TYPE BODY)., lsaenz 09/21/1999 Made symbol substitution optional (by using a parameter in executeSQLFile()) in processLine()., lsaenz 09/20/1999 Fixed various bugs, added feature to skip C-style comments within files., lsaenz 08/26/1999 Updated comments, modifed class to work with new oracle.ifs.installer classes., echui 04/19/1999 Appended '@' to DB URL for Oracle8i., echui 12/28/1998 Modified pop() to close BufferedReader., echui 12/01/1998 Fixed bug in getLine()., echui 11/03/1998 Used StringBuffers instead of Strings., echui 10/26/1998 Used JDBC instead of SQLJ., echui 10/16/1998 Created.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALPHANUM` String containing all alphanumeric characters, according to SQL.
`static String`	`DELIMITER` String constant.
`static int`	`IFSTATE_ELSE` Mode for IFSTATE.
`static int`	`IFSTATE_IF` Mode for IFSTATE.
`static int`	`IFSTATE_NONE` Mode for IFSTATE.
`static int`	`LINE_LEN` SQLProcessor constant.
`static int`	`SQLSTMT_LEN` SQLProcessor constant.
`static int`	`SYMBOLS_NONE` Mode for SYMBOLS.
`static int`	`SYMBOLS_OFF` Mode for SYMBOLS.
`static int`	`SYMBOLS_ON` Mode for SYMBOLS.
`static String`	`WHITESPACE` String constant.

Constructor Summary

Constructors
Constructor and Description
`SQLProcessor()` Construct a new `SQLProcessor` class.
`SQLProcessor(Connection con)` Construct a new `SQLProcessor` class given an existing Connection to a database.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disconnect()` Closes the Connection to the database.
`String`	`doExpandLine(String line, Hashtable dict)` Removes symbol delimiter dots from lines with & symbols
`void`	`expandLine(String line, StringBuffer buffer, Hashtable dict, int substitution)` Expands a line by substituting symbols.
`void`	`finalize()` Finalizes this `SQLProcessor`.
`Connection`	`getConnection()` Returns the Connection to the database.
`static void`	`main(String[] args)`
`void`	`processLine(oracle.ifs.admin.sql.SQLProcessor.Context ctx, String line, StringBuffer sqlbuf)` Handles a line of SQL.
`void`	`runSQLFile(String infile, String outfile, Hashtable dict)` Executes a SQL file.
`void`	`runSQLFile(String infile, String outfile, Hashtable dict, boolean substitute, boolean echo, boolean noExecute, boolean stopOnErrors)`
`void`	`runSQLFile(String infile, String outfile, Hashtable dict, boolean substitute, boolean echo, boolean noExecute, boolean stopOnErrors, String connectString)` Executes a SQL file.
`void`	`setConnection(Connection con)` Sets the Connection to a database.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- LINE_LEN
```
public static final int LINE_LEN
```
  SQLProcessor constant.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- SQLSTMT_LEN
```
public static final int SQLSTMT_LEN
```
  SQLProcessor constant.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- SYMBOLS_NONE
```
public static final int SYMBOLS_NONE
```
  Mode for SYMBOLS.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- SYMBOLS_OFF
```
public static final int SYMBOLS_OFF
```
  Mode for SYMBOLS.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- SYMBOLS_ON
```
public static final int SYMBOLS_ON
```
  Mode for SYMBOLS.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- IFSTATE_NONE
```
public static final int IFSTATE_NONE
```
  Mode for IFSTATE.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- IFSTATE_IF
```
public static final int IFSTATE_IF
```
  Mode for IFSTATE.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- IFSTATE_ELSE
```
public static final int IFSTATE_ELSE
```
  Mode for IFSTATE.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- WHITESPACE
```
public static final String WHITESPACE
```
  String constant.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- DELIMITER
```
public static final String DELIMITER
```
  String constant.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- ALPHANUM
```
public static final String ALPHANUM
```
  String containing all alphanumeric characters, according to SQL.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)

Constructor Detail
- SQLProcessor
```
public SQLProcessor()
```
  Construct a new SQLProcessor class. No connection is made to a database.
  
  (Unpublished)
- SQLProcessor
```
public SQLProcessor(Connection con)
             throws SQLException
```
  Construct a new SQLProcessor class given an existing Connection to a database.
  
  Parameters:
  
  con - an existing JDBC Connection to a database.
  
  Throws:
  
  SQLException - if an error occurs when trying to use the new Connection.
  
  (Unpublished)

Method Detail

getConnection
```
public Connection getConnection()
```
Returns the Connection to the database.

Returns:

the Connection to the database, or null if no Connection has been established.

(Unpublished)

disconnect
```
public void disconnect()
                throws SQLException
```
Closes the Connection to the database.

Throws:

SQLException - if an error occurs when trying to close the Connection.

(Unpublished)

setConnection
```
public void setConnection(Connection con)
                   throws SQLException
```
Sets the Connection to a database.

Parameters:

con - a JDBC Connection to a database.

Throws:

SQLException - if an error occurs when trying to create a Statement from the new Connection.

(Unpublished)

finalize
```
public void finalize()
```
Finalizes this SQLProcessor. Closes any remaining JDBC Connections or SQL Statements.

Overrides:

finalize in class Object

(Unpublished)

runSQLFile

public void runSQLFile(String infile,
                       String outfile,
                       Hashtable dict,
                       boolean substitute,
                       boolean echo,
                       boolean noExecute,
                       boolean stopOnErrors)
                throws SQLProcessorException,
                       IOException

Throws:: SQLProcessorException; IOException

runSQLFile

public void runSQLFile(String infile,
                       String outfile,
                       Hashtable dict,
                       boolean substitute,
                       boolean echo,
                       boolean noExecute,
                       boolean stopOnErrors,
                       String connectString)
                throws SQLProcessorException,
                       IOException

Executes a SQL file.

Throws:: SQLProcessorException; IOException
(Unpublished)

runSQLFile

public void runSQLFile(String infile,
                       String outfile,
                       Hashtable dict)
                throws SQLProcessorException,
                       IOException

Executes a SQL file.

Throws:: SQLProcessorException; IOException
(Unpublished)

expandLine

public void expandLine(String line,
                       StringBuffer buffer,
                       Hashtable dict,
                       int substitution)
                throws SQLProcessorException

Expands a line by substituting symbols.

Throws:: SQLProcessorException
(Unpublished)

doExpandLine

public String doExpandLine(String line,
                           Hashtable dict)

Removes symbol delimiter dots from lines with & symbols

processLine

public void processLine(oracle.ifs.admin.sql.SQLProcessor.Context ctx,
                        String line,
                        StringBuffer sqlbuf)
                 throws SQLProcessorException

Handles a line of SQL.

Throws:: SQLProcessorException
(Unpublished)

main

public static void main(String[] args)

Class SQLProcessor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LINE_LEN

SQLSTMT_LEN

SYMBOLS_NONE

SYMBOLS_OFF

SYMBOLS_ON

IFSTATE_NONE

IFSTATE_IF

IFSTATE_ELSE

WHITESPACE

DELIMITER

ALPHANUM

Constructor Detail

SQLProcessor

SQLProcessor

Method Detail

getConnection

disconnect

setConnection

finalize

runSQLFile

runSQLFile

runSQLFile

expandLine

doExpandLine

processLine

main