com.toolsverse.etl.parser

Class GenericSqlParser

Object

com.toolsverse.etl.parser.GenericSqlParser

All Implemented Interfaces:

SqlParser, Serializable

public class GenericSqlParser
extends Object
implements SqlParser

The default implementation of the SqlParser interface. Uses RSyntaxDocument as an actual sql parser.

Since:

1.0

Version:

2.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GenericSqlParser.ParamsParser The Class ParamsParser.
class	GenericSqlParser.SplitParser The Class SplitParser.
class	GenericSqlParser.SqlTypeParser The Class SqlTypeParser.
class	GenericSqlParser.StripParser The Class StripParser.

Constructor Summary

Constructors

Constructor and Description
GenericSqlParser()

Method Summary

Modifier and Type	Method and Description
Variable	getVariable(String name, Driver driver) Creates a variable using given name and a driver.
boolean	isCallable(String sql) Checks if sql statement is callable.
String	parseParams(String sql, Map<String,Object> params, Map<String,List<Integer>> paramMap, List<String> outputParams, Driver driver) Parses the sql, updates params, paramMap and outputParams.
String	removeChars(String sql) Removes chars prohibited in the sql.
void	setBindVariables(PreparedStatement st, Map<String,Object> properties, Map<String,List<Integer>> paramMap, List<String> outpurParams, Driver driver) Sets the bind variables for the given prepared statement, including registering output parameters if any exist.
String	setBindVariables(String sql, Map<String,Object> properties) Sets the bind variables using given properties.
String[]	split(String sql) Splits given sql on multiple sql statements using ";" as a separator.
String	stripComments(String sql) Strip comments.

Methods inherited from class Object

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

Constructor Detail

GenericSqlParser

public GenericSqlParser()

Method Detail

getVariable

public Variable getVariable(String name,
                            Driver driver)

Description copied from interface: SqlParser

Creates a variable using given name and a driver. The variable is used to register output parameter for the callable sql statement.

The expected format: out_type_name.

Examples:

out_number_abc

out_cursor_xyz

Specified by:

getVariable in interface SqlParser

Parameters:

name - the name

driver - the driver

Returns:

the variable

isCallable

public boolean isCallable(String sql)

Description copied from interface: SqlParser

Checks if sql statement is callable. The callable statement is an anonymous sql block, function or a procedure.

Specified by:

isCallable in interface SqlParser

Parameters:

sql - the sql

Returns:

true, if sql statement is callable

parseParams

public String parseParams(String sql,
                          Map<String,Object> params,
                          Map<String,List<Integer>> paramMap,
                          List<String> outputParams,
                          Driver driver)

Description copied from interface: SqlParser

Parses the sql, updates params, paramMap and outputParams.

Specified by:

parseParams in interface SqlParser

Parameters:

sql - the sql

params - the bind variables.

paramMap - the map containing bind variable name name as key and a list of parameter indexes as a value.

For example:

     select * from abc
     where xyz = :xyz and mmm = :xyz
 

the map will contain "xyz" as a key and a list {1,2} as a value.

outputParams - the output params

driver - the driver

Returns:

the string

removeChars

public String removeChars(String sql)

Description copied from interface: SqlParser

Removes chars prohibited in the sql.

Specified by:

removeChars in interface SqlParser

Parameters:

sql - the sql

Returns:

the sql

setBindVariables

public void setBindVariables(PreparedStatement st,
                             Map<String,Object> properties,
                             Map<String,List<Integer>> paramMap,
                             List<String> outpurParams,
                             Driver driver)
                      throws Exception

Description copied from interface: SqlParser

Sets the bind variables for the given prepared statement, including registering output parameters if any exist. Properties is a map containing variable name\value pairs.

Specified by:

setBindVariables in interface SqlParser

Parameters:

st - the prepared statement

properties - the properties

paramMap - the map containing bind variable name name as key and a list of parameter indexes as a value.

For example:

     select * from abc
     where xyz = :xyz and mmm = :xyz
 

the map will contain "xyz" as a key and a list {1,2} as a value.

outpurParams - the list of output parameters, if any exist

driver - the driver

Throws:

Exception - in case of any error

setBindVariables

public String setBindVariables(String sql,
                               Map<String,Object> properties)

Description copied from interface: SqlParser

Sets the bind variables using given properties. The bind variable can be defined inside sql as :name. Example: :abc Properties is a map containing variable name\value pairs. Ignores ":name" in comments and parameters.

Specified by:

setBindVariables in interface SqlParser

Parameters:

sql - the sql

properties - the properties

Returns:

the original sql with bind variables substituted on vales.

split

public String[] split(String sql)

Description copied from interface: SqlParser

Splits given sql on multiple sql statements using ";" as a separator. Ignores ";" in comments and parameters.

Specified by:

split in interface SqlParser

Parameters:

sql - the sql

Returns:

the sql statements

stripComments

public String stripComments(String sql)

Description copied from interface: SqlParser

Strip comments.

Specified by:

stripComments in interface SqlParser

Parameters:

sql - the sql

Returns:

the string