SqlStatementUtil (josef 3.2.5 API)

java.lang.Object
- org.josef.jdbc.SqlStatementUtil

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Reviews(value=@Review(by="Kees Schotanus",at="2009-04-13"))
public final class SqlStatementUtil
extends Object

Utility class for creating SQL statements.

Version:: 1.0 $Revision: 6483 $
Author:: Kees Schotanus

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static StringBuffer`	`addToWhereClause(StringBuffer whereClause, String operator, String expression)` Adds the supplied operator and expression to an existing (and supplied) whereClause.
`static boolean`	`containsWildcard(String expression)` Determines whether the supplied expression contains a SQL wildcard character.
`static String`	`createCommaSeparatedValues(Object... values)` Creates a list of comma separated (database column) values.
`static <T extends Enum<T> & LocalizableEnumeration> String`	`createDecodeArgument(String expression, Class<T> localizableEnumeration, Locale locale)` Creates a String which can be used as an argument to Oracle's decode function.
`static String`	`createDecodeArgument(String expression, Collection<? extends CodeDescription> codeDescriptions, String defaultValue)` Creates a String which can be used as an argument to Oracle's decode function.
`static String`	`createEndsWithParameter(String expression)` Creates a SQL parameter that can be used in a SQL LIKE clause suitable for selecting columns that end with the supplied expression.
`static String`	`createInClause(String databaseColumn, Object... values)` Creates an IN clause for a SQL statement.
`static String`	`createNotInClause(String databaseColumn, Object... values)` Creates a NOT IN clause for a SQL statement.
`static String`	`createStartsWithParameter(String expression)` Creates a SQL parameter that can be used in a SQL LIKE clause suitable for selecting columns that start with the supplied expression.
`static String`	`createStoredProcedureCall(String name, StoredProcedureParameter... parameters)` Creates a SQL statement to call a stored procedure.
`static StringBuffer`	`createWhereClause(String expression)` Creates a sql WHERE clause.
`static String`	`quoteSqlValue(Object value)` Quotes a SQL value.

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

- Method Detail
  - createWhereClause
```
public static StringBuffer createWhereClause(String expression)
```
    Creates a sql WHERE clause.
    Use this method in combination with addToWhereClause(StringBuffer, String, String) to construct more complex WHERE clauses. The following code for example creates a clause that looks like: WHERE (A=1 AND B=1) OR B=2 AND C IN('a','b','c')
```
StringBuffer whereClause = createWhereClause("(A=1 AND B=1)");
 addToWhereClause(whereClause, "OR", "B=2");
 addToWhereClause(whereClause, "AND",
     createInClause("C", new String [] {"a", "b", "c"}));
```
    Be careful to encode your expression to prevent SQL injection problems.
    Parameters:
    
    expression - The initial expression to add to the newly created WHERE clause.
    
    Returns:
    
    A WHERE clause with the supplied expression.
    
    Throws:
    
    IllegalArgumentException - When the supplied expression is empty.
    
    NullPointerException - When the supplied expression is null.
  - addToWhereClause
```
public static StringBuffer addToWhereClause(StringBuffer whereClause,
                                            String operator,
                                            String expression)
```
    Adds the supplied operator and expression to an existing (and supplied) whereClause.
    Be careful to encode your expression to prevent SQL injection problems.
    
    Parameters:
    
    whereClause - WHERE clause created by createWhereClause(String).
    
    operator - An operator like 'AND', 'OR', '=' et cetera.
    
    expression - A SQL expression.
    
    Returns:
    
    The supplied whereClause augmented with the supplied operator and expression.
  - containsWildcard
```
public static boolean containsWildcard(String expression)
```
    Determines whether the supplied expression contains a SQL wildcard character.
    
    Parameters:
    
    expression - Expression to check for SQL wildcard characters.
    
    Returns:
    
    True when the supplied expression contains one or more SQL wildcard characters, false otherwise.
    
    Throws:
    
    NullPointerException - When the supplied expression is null.
  - createStartsWithParameter
```
public static String createStartsWithParameter(String expression)
```
    Creates a SQL parameter that can be used in a SQL LIKE clause suitable for selecting columns that start with the supplied expression.
    This method adds the "%" wildcard to end of the supplied expression unless the supplied expression already contains a "%" wildcard character as the last character.
    
    Parameters:
    
    expression - The SQL expression.
    
    Returns:
    
    A SQL expression that can be used in a SQL LIKE clause to fetch columns that start with the supplied expression.
    
    Throws:
    
    NullPointerException - When the supplied expression is null.
  - createEndsWithParameter
```
public static String createEndsWithParameter(String expression)
```
    Creates a SQL parameter that can be used in a SQL LIKE clause suitable for selecting columns that end with the supplied expression.
    This method adds the "%" wildcard at the beginning of the supplied expression unless the supplied expression already contains a "%" wildcard character as the first character.
    
    Parameters:
    
    expression - The SQL expression.
    
    Returns:
    
    A SQL expression that can be used in a SQL LIKE clause to fetch columns that end with the supplied expression.
    
    Throws:
    
    NullPointerException - When the supplied expression is null.
  - createInClause
```
public static String createInClause(String databaseColumn,
                                    Object... values)
```
    Creates an IN clause for a SQL statement.
    Parameters:
    databaseColumn - The database column as it should appear in the SQL statement.
    It's the responsibility of the programmer that the supplied databaseColumn is valid within the SQL statement. Examples:
    
    TABLE_NAME.COLUMN_NAME
    
    ALIAS.COLUMN_NAME
    
    COLUMN_NAME
    values - The values to appear in the IN clause.
    All values should probably be of the same type but this is not enforced by this method.
    
    Returns:
    
    An IN clause.
    
    Throws:
    
    IllegalArgumentException - When either the supplied databaseColumn or the supplied values array is empty.
    
    NullPointerException - When either the supplied databaseColumn or the supplied values array is null.
  - createNotInClause
```
public static String createNotInClause(String databaseColumn,
                                       Object... values)
```
    Creates a NOT IN clause for a SQL statement.
    Parameters:
    databaseColumn - The database column as it should appear in the SQL statement.
    It's the responsibility of the programmer that the supplied databaseColumn is valid within the SQL statement. Examples:
    
    TABLE_NAME.COLUMN_NAME
    
    ALIAS.COLUMN_NAME
    
    COLUMN_NAME
    values - The values to appear in the NOT IN clause.
    All values should probably be of the same type but this is not enforced by this method.
    
    Returns:
    
    A NOT IN clause.
    
    Throws:
    
    IllegalArgumentException - When either the supplied databaseColumn or the supplied values array is empty.
    
    NullPointerException - When either the supplied databaseColumn or the supplied values array is null.
  - createCommaSeparatedValues
```
public static String createCommaSeparatedValues(Object... values)
```
    Creates a list of comma separated (database column) values.
    Each value will be properly (single) quoted when applicable.
    
    Parameters:
    
    values - The values that must be comma separated.
    
    Returns:
    
    A list of comma separated values, which can possibly be empty, but never null.
  - createDecodeArgument
```
public static <T extends Enum<T> & LocalizableEnumeration> String createDecodeArgument(String expression,
                                                                                       Class<T> localizableEnumeration,
                                                                                       Locale locale)
```
    Creates a String which can be used as an argument to Oracle's decode function.
    The syntax of the decode function is: decode(expression, code, value [,code, value]... [,defaultValue])
    Note: This method does not handle the defaultValue. For a method that does, see: createDecodeArgument(String, Collection, String).
    
    Type Parameters:
    
    T - The type of the localizable enumeration.
    
    Parameters:
    
    expression - The decode expression.
    
    localizableEnumeration - The localizable enumeration to be used in the decode function.
    
    locale - The locale to localize the descriptions of the supplied constants.
    When null is supplied, the default Locale is used.
    
    Returns:
    
    A String which can be used as an argument to Oracle's decode function.
    
    Throws:
    
    NullPointerException - When either the supplied expression or localizableEnumeration is null.
    
    IllegalArgumentException - When the supplied expression is empty.
  - createDecodeArgument
```
public static String createDecodeArgument(String expression,
                                          Collection<? extends CodeDescription> codeDescriptions,
                                          String defaultValue)
```
    Creates a String which can be used as an argument to Oracle's decode function.
    The syntax of the decode function is: decode(expression, code, value [,code, value]... [,defaultValue])
    
    Parameters:
    
    expression - The decode expression.
    
    codeDescriptions - The code/description pairs to be used in the decode function.
    
    defaultValue - The optional default value.
    
    Returns:
    
    A String which can be used as an argument to Oracle's decode function.
    
    Throws:
    
    NullPointerException - When either the supplied expression or codeDescriptions is null.
    
    IllegalArgumentException - When the supplied expression or codeDescriptions is empty.
  - quoteSqlValue
```
public static String quoteSqlValue(Object value)
```
    Quotes a SQL value.
    Strings are surrounded with single quotes. String values that already contain single quotes are encoded properly.
    
    Parameters:
    
    value - The value to quote.
    
    Returns:
    
    The properly quoted, supplied value.
    
    Throws:
    
    NullPointerException - When the supplied value is null.
  - createStoredProcedureCall
```
public static String createStoredProcedureCall(String name,
                                               StoredProcedureParameter... parameters)
```
    Creates a SQL statement to call a stored procedure.
    
    Parameters:
    
    name - Name of the stored procedure.
    
    parameters - The (optional) parameters.
    
    Returns:
    
    A SQL statement to call a stored procedure.
    
    Throws:
    
    NullPointerException - When the supplied name is null.

Class SqlStatementUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createWhereClause

addToWhereClause

containsWildcard

createStartsWithParameter

createEndsWithParameter

createInClause

createNotInClause

createCommaSeparatedValues

createDecodeArgument

createDecodeArgument

quoteSqlValue

createStoredProcedureCall