com.archibus.datasource

Class SqlUtils

java.lang.Object

com.archibus.datasource.SqlUtils

public class SqlUtils
extends java.lang.Object

Provides static methods to execute SQL queries and format values for SQL.

Constructor Summary

Constructors

Constructor and Description
SqlUtils()

Method Summary

Modifier and Type	Method and Description
static void	checkEditPermission(java.lang.String tableName) Checks if user has the permission to edit a specified table.
static void	commit() Commits the current database transaction.
static java.util.List<com.archibus.datasource.data.DataRecord>	executeQuery(java.lang.String tableName, java.lang.String[] fieldNames, java.lang.String sql) Executes SQL query and returns all records (no record limit).
static void	executeUpdate(java.lang.String tableName, java.lang.String sql) Executes SQL update query without checking user's permission to edit specified table.
static void	executeUpdate(java.lang.String tableName, java.lang.String sql, boolean checkTableEditPermission) Executes SQL update query with the option to check user's permission to edit specified table.
static void	executeUpdateRequired(java.lang.String tableName, java.lang.String sql) Executes SQL update query.
static java.lang.String	formatSqlReplace0WithHuge(java.lang.String value) Replaces any expression that returns a 0 result with a very large number (9999999999)
static java.lang.String	formatValueForSql(java.lang.Object value) Formats field value for SQL.
static boolean	isOracle() Returns true if the current database is Oracle.
static boolean	isSqlServer() Returns true if the current database is SQL Server.
static boolean	isSybase() Returns true if the current database is Sybase.
static java.lang.String	makeLiteralOrBlank(java.lang.String value) Returns literalized version of specified string, or an empty string if specified string is null.
static java.lang.Object	normalizeValueForSql(java.lang.Object value) Converts value to type that is accepted by the SQL layer: java.util.Date --> java.sql.Date
static void	normalizeValuesForSql(java.util.Map<java.lang.String,java.lang.Object> values) Converts values to types that are accepted by the SQL layer.
static void	rollback() Rolls back the current database transaction.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlUtils

public SqlUtils()

Method Detail

executeUpdate

public static void executeUpdate(java.lang.String tableName,
                                 java.lang.String sql)

Executes SQL update query without checking user's permission to edit specified table.

Parameters:

tableName - - String table Name.

sql - - String sql statement.

executeUpdate

public static void executeUpdate(java.lang.String tableName,
                                 java.lang.String sql,
                                 boolean checkTableEditPermission)

Executes SQL update query with the option to check user's permission to edit specified table.

Parameters:

tableName - - String table Name.

sql - - String sql statement.

checkTableEditPermission - - boolean.

executeUpdateRequired

public static void executeUpdateRequired(java.lang.String tableName,
                                         java.lang.String sql)

Executes SQL update query. Throws an exception if the record was not updated.

This is a replacement for EventHandlerBase.executeDbSql(EventHandlerContext context, String tableName, String sql, boolean updatedRecordsRequired).

Parameters:

tableName - - String table Name.

sql - - String sql statement.

executeQuery

public static java.util.List<com.archibus.datasource.data.DataRecord> executeQuery(java.lang.String tableName,
                                                                                   java.lang.String[] fieldNames,
                                                                                   java.lang.String sql)

Executes SQL query and returns all records (no record limit).

Parameters:

tableName - Table name.

fieldNames - Names of fields which will be retrieved.

sql - Custom SQL query.

commit

public static void commit()

Commits the current database transaction.

rollback

public static void rollback()

Rolls back the current database transaction.

isOracle

public static boolean isOracle()

Returns true if the current database is Oracle.

Returns:

isSqlServer

public static boolean isSqlServer()

Returns true if the current database is SQL Server.

Returns:

isSybase

public static boolean isSybase()

Returns true if the current database is Sybase.

Returns:

formatValueForSql

public static java.lang.String formatValueForSql(java.lang.Object value)

Formats field value for SQL.

Parameters:

value -

Returns:

makeLiteralOrBlank

public static java.lang.String makeLiteralOrBlank(java.lang.String value)

Returns literalized version of specified string, or an empty string if specified string is null. Only puts doubles up internal quotes - does not put quotes on each end.

Parameters:

value -

Returns:

formatSqlReplace0WithHuge

public static java.lang.String formatSqlReplace0WithHuge(java.lang.String value)

Replaces any expression that returns a 0 result with a very large number (9999999999)

Parameters:

value -

Returns:

normalizeValueForSql

public static java.lang.Object normalizeValueForSql(java.lang.Object value)

Converts value to type that is accepted by the SQL layer:

java.util.Date --> java.sql.Date

Parameters:

value -

Returns:

normalizeValuesForSql

public static void normalizeValuesForSql(java.util.Map<java.lang.String,java.lang.Object> values)

Converts values to types that are accepted by the SQL layer.

Parameters:

values - - Map.

checkEditPermission

public static void checkEditPermission(java.lang.String tableName)

Checks if user has the permission to edit a specified table. if no permission, throws a exception.

Parameters:

tableName - - String table name.