ilog.views.util.data

Class IlvJDBCQueryUtil

java.lang.Object

ilog.views.util.data.IlvJDBCQueryUtil

public class IlvJDBCQueryUtil
extends Object

This class contains utility functions for manipulating SQL queries.

Since:

JViews 8.8

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvJDBCQueryUtil.IdentifierChain This class contains utility functions for manipulating identifier chains (sequences of identifiers, separated by periods) in SQL syntax.
static interface	IlvJDBCQueryUtil.QueryCharacterHandler This interface is used to iterate over the characters of a query string, separating comments from non-comment tokens.

Method Summary

Modifier and Type	Method and Description
static String	combineQueryWithParameters(Connection connection, String query, Object[] queryParameters) Combines a query string with query parameters, forming a query string that can be used without parameters.
static String	combineQueryWithParameters(String query, Object[] queryParameters) Combines a query string with query parameters, forming a query string that can be used without parameters.
static String	convertToString(Object object) Converts a query parameter object to a string in SQL syntax that can be used in an SQL query string.
static void	recognizeComments(CharSequence s, IlvJDBCQueryUtil.QueryCharacterHandler handler) Parses a string in SQL syntax by dissecting it into comments and non-comment characters.
static String	validateColumnName(String columnName) Validates that a given column name is valid in SQL syntax without needing escaping.
static String	validateColumnReference(String columnReference) Validates that a given column reference is valid in SQL syntax without needing escaping.
static String	validateIdentifier(String identifier) Validates that a given identifier is valid in SQL syntax without needing escaping.
static String	validateTableName(String tableName) Validates that a given table name is valid in SQL syntax without needing escaping.

Methods inherited from class java.lang.Object

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

Method Detail

recognizeComments

public static void recognizeComments(CharSequence s,
                                     IlvJDBCQueryUtil.QueryCharacterHandler handler)
                              throws SQLException

Parses a string in SQL syntax by dissecting it into comments and non-comment characters.

Parameters:

s - A piece of query string, in SQL syntax.

handler - An object that receives the comments and non-comment characters.

Throws:

SQLException - if the comment syntax is ambiguous

combineQueryWithParameters

public static String combineQueryWithParameters(Connection connection,
                                                String query,
                                                Object[] queryParameters)
                                         throws SQLException

Combines a query string with query parameters, forming a query string that can be used without parameters.

Parameters:

connection - A connection to the database.

query - An SQL query, with question marks as placeholders for the parameters. Named parameters are not supported.

queryParameters - An array of parameters for the query.

Returns:

An SQL query, with all parameters substituted inline.

Throws:

SQLException - if the comment syntax is ambiguous

IllegalArgumentException - if the number of parameters does not match the number of question marks in the query, or if some of the parameters do not have a supported type

combineQueryWithParameters

public static String combineQueryWithParameters(String query,
                                                Object[] queryParameters)
                                         throws SQLException

Combines a query string with query parameters, forming a query string that can be used without parameters.

Parameters:

query - An SQL query, with question marks as placeholders for the parameters. Named parameters are not supported.

queryParameters - An array of parameters for the query.

Returns:

An SQL query, with all parameters substituted inline.

Throws:

SQLException - if the comment syntax is ambiguous

IllegalArgumentException - if the number of parameters does not match the number of question marks in the query, or if some of the parameters do not have a supported type

convertToString

public static String convertToString(Object object)

Converts a query parameter object to a string in SQL syntax that can be used in an SQL query string.

Parameters:

object - An object.

Returns:

A string in SQL syntax.

Throws:

IllegalArgumentException - if object does not have a supported type

validateIdentifier

public static String validateIdentifier(String identifier)
                                 throws SQLException

Validates that a given identifier is valid in SQL syntax without needing escaping.

This function accepts regular identifiers and double-quote delimited identifiers. It does not accept Unicode delimited identifiers or syntaxes that depend on the brand of database. It also does not support whitespace or embedded comments.

Parameters:

identifier - A string.

Returns:

identifier, with a guarantee that it can be used in an SQL query string.

Throws:

SQLException - if the given identifier is invalid

validateTableName

public static String validateTableName(String tableName)
                                throws SQLException

Validates that a given table name is valid in SQL syntax without needing escaping.

Parameters:

tableName - A string.

Returns:

tableName, with a guarantee that it can be used in an SQL query string. It has the syntax of an identifier chain.

Throws:

SQLException - if the given table name is invalid

See Also:

IlvJDBCQueryUtil.IdentifierChain

validateColumnName

public static String validateColumnName(String columnName)
                                 throws SQLException

Validates that a given column name is valid in SQL syntax without needing escaping.

This function accepts identifiers like validateIdentifier(String) does.

Note that all column names are column references, but not vice versa.

Parameters:

columnName - A string.

Returns:

columnName, with a guarantee that it can be used in an SQL query string.

Throws:

SQLException - if the given column name is invalid

validateColumnReference

public static String validateColumnReference(String columnReference)
                                      throws SQLException

Validates that a given column reference is valid in SQL syntax without needing escaping.

Parameters:

columnReference - A string.

Returns:

columnReference, with a guarantee that it can be used in an SQL query string. It has the syntax of an identifier chain.

Throws:

SQLException - if the given column reference is invalid

See Also:

IlvJDBCQueryUtil.IdentifierChain