oracle.pg.common

Class Util

java.lang.Object

oracle.pg.common.Util

public class Util
extends java.lang.Object

This class contains some useful helper functions. Many of the methods are wrapper functions of what are provided in oracle.spatial.util.Util.

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	checkSQLName(java.lang.String string, int maxStringLength) Checks for any illegal characters in a SQL name.
static boolean	compareDates(java.lang.Object o1, java.lang.Object o2) Returns true if two given objects (either a Date object or a String representation of a Date object) are the same.
static java.lang.String	enquoteColumnName(java.sql.Connection conn, java.lang.String columnName) Enquotes a column name.
static java.lang.String	enquoteColumnNameCaseSensitive(java.sql.Connection conn, java.lang.String name) Enquotes a column name.
static java.lang.String	enquoteLiteral(java.sql.Connection conn, java.lang.String name) This method enquotes a literal value.
static java.lang.String	enquoteLiteral(java.sql.Connection conn, java.lang.String literal, int maxLengthAllowed) Returns the enquoted literal
static java.lang.String	enquoteNameSQLName(java.sql.Connection conn, java.lang.String name) Returns the ENQUOTE_NAME formatted String for the SQL name If the Oracle JDBC is present, use the new OracleStatement.enquoteIdentifier API in the JDK8 JDBC.
static java.lang.String	enquoteTableName(java.sql.Connection conn, java.lang.String tableName) Enquotes a table name with or without schema name which is separated by ".".
static int	getMaxLengthAllowed()
static java.lang.String	getValidatedGraphName(java.sql.Connection conn, java.lang.String graphName) Returns the validated graph name
static java.lang.String	getValidatedGraphName(java.sql.Connection conn, java.lang.String graphName, int maxLengthAllowed) Returns the validated graph name
static java.lang.String	myCheckName(java.lang.String string) Checks for any illegal characters in a SQL name.
static java.lang.String	qualifiedSQLName(java.sql.Connection conn, java.lang.String name) Checks if the specified name is a qualified SQL name.
static java.lang.String	sanitizeSimpleFileName(java.lang.String fileName) do sanity checking to the filename, only allowed characters can appear in the file name
static java.lang.String	simpleSqlNameCheck(java.sql.Connection conn, java.lang.String name) This method returns the result of OracleStatement.enquoteIdentifier function: If identifier is a simple SQL identifier, the original value is returned A SQLException will be thrown if identifier contains any characters invalid in a delimited identifier or the identifier length is invalid for the datasource.

Methods inherited from class java.lang.Object

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

Constructor Detail

Util

public Util()

Method Detail

checkSQLName

public static java.lang.String checkSQLName(java.lang.String string,
                                            int maxStringLength)
                                     throws java.sql.SQLException

Checks for any illegal characters in a SQL name. Only alpha-numeric characters and "_","$","#" are allowed.

Parameters:

string - input string

maxStringLength - maximum length for input string

Returns:

string Retruns the string if passes the check

Throws:

java.sql.SQLException - An exception is thrown if the input string contains any illegal characters or exceeds the maximum length

compareDates

public static boolean compareDates(java.lang.Object o1,
                                   java.lang.Object o2)

Returns true if two given objects (either a Date object or a String representation of a Date object) are the same.

Parameters:

o1 - must be either a Date object or String

o2 - must be either a Date object or String

enquoteColumnName

public static java.lang.String enquoteColumnName(java.sql.Connection conn,
                                                 java.lang.String columnName)
                                          throws java.sql.SQLException

Enquotes a column name.

Parameters:

conn -

columnName -

Returns:

String

Throws:

java.sql.SQLException

enquoteColumnNameCaseSensitive

public static java.lang.String enquoteColumnNameCaseSensitive(java.sql.Connection conn,
                                                              java.lang.String name)
                                                       throws java.sql.SQLException

Enquotes a column name.

Throws:

java.sql.SQLException

enquoteLiteral

public static java.lang.String enquoteLiteral(java.sql.Connection conn,
                                              java.lang.String name)
                                       throws java.sql.SQLException

This method enquotes a literal value. It calls SYS.DBMS_ASSERT.enquoteLiteral function.

Parameters:

conn - the database connection

name - the input literal

Returns:

string Retruns the string if passes the check

Throws:

java.sql.SQLException - A SQLexception is thrown if the dbms_assert.qualified_sql_name failed

enquoteLiteral

public static java.lang.String enquoteLiteral(java.sql.Connection conn,
                                              java.lang.String literal,
                                              int maxLengthAllowed)
                                       throws java.sql.SQLException

Returns the enquoted literal

Parameters:

conn - the database connection

literal - the input name

Throws:

java.sql.SQLException

enquoteNameSQLName

public static java.lang.String enquoteNameSQLName(java.sql.Connection conn,
                                                  java.lang.String name)
                                           throws java.sql.SQLException

Returns the ENQUOTE_NAME formatted String for the SQL name If the Oracle JDBC is present, use the new OracleStatement.enquoteIdentifier API in the JDK8 JDBC. Otherwise use the DBMS_ASSERT.ENQUOTE_NAME formatted String for the SQL name using "false" for the second parameter (i.e., no capitalization of SQL name). This method is added due to avoid SQL Injection issues.

Parameters:

conn - the database connection

name - the input name

Throws:

java.sql.SQLException

enquoteTableName

public static java.lang.String enquoteTableName(java.sql.Connection conn,
                                                java.lang.String tableName)
                                         throws java.sql.SQLException

Enquotes a table name with or without schema name which is separated by ".". This method also can be used to enquote all column names, including object column names like col.attr1.attr2.attr3 == "COL"."ATTR1"."ATTR2"."ATTR3"

Parameters:

conn -

tableName -

Returns:

String

Throws:

java.sql.SQLException

getMaxLengthAllowed

public static int getMaxLengthAllowed()

getValidatedGraphName

public static java.lang.String getValidatedGraphName(java.sql.Connection conn,
                                                     java.lang.String graphName)
                                              throws java.sql.SQLException

Returns the validated graph name

Parameters:

conn - the database connection

graphName - the input graph name

Throws:

java.sql.SQLException

getValidatedGraphName

public static java.lang.String getValidatedGraphName(java.sql.Connection conn,
                                                     java.lang.String graphName,
                                                     int maxLengthAllowed)
                                              throws java.sql.SQLException

Returns the validated graph name

Parameters:

conn - the database connection

graphName - the input graph name

Throws:

java.sql.SQLException

myCheckName

public static java.lang.String myCheckName(java.lang.String string)
                                    throws java.sql.SQLException

Checks for any illegal characters in a SQL name. Only alpha-numeric characters and ".", "_","$","#" are allowed.

Parameters:

string - input string

Returns:

string Retruns the string if passes the check

Throws:

java.sql.SQLException - An exception is thrown if the input string contains any illegal characters or exceeds the maximum length

qualifiedSQLName

public static java.lang.String qualifiedSQLName(java.sql.Connection conn,
                                                java.lang.String name)
                                         throws java.sql.SQLException

Checks if the specified name is a qualified SQL name. It calls SYS.DBMS_ASSERT.qualified_sql_name function.

Parameters:

conn - the database connection

name - the input name

Returns:

string Retruns the string if passes the check

Throws:

java.sql.SQLException - A SQLexception is thrown if the dbms_assert.qualified_sql_name failed

sanitizeSimpleFileName

public static java.lang.String sanitizeSimpleFileName(java.lang.String fileName)
                                               throws java.lang.IllegalArgumentException

do sanity checking to the filename, only allowed characters can appear in the file name

Parameters:

fileName -

Returns:

String

Throws:

java.lang.IllegalArgumentException

simpleSqlNameCheck

public static java.lang.String simpleSqlNameCheck(java.sql.Connection conn,
                                                  java.lang.String name)
                                           throws java.sql.SQLException

This method returns the result of OracleStatement.enquoteIdentifier function: If identifier is a simple SQL identifier, the original value is returned A SQLException will be thrown if identifier contains any characters invalid in a delimited identifier or the identifier length is invalid for the datasource.

Parameters:

conn - the database connection

name - the input literal

Returns:

string Retruns the output of OracleStatement.enquoteIdentifier if passes the check

Throws:

java.sql.SQLException - A SQLexception is thrown if the assertion failed