oracle.pg.rdbms.pgql

Class PgqlUtils

java.lang.Object

oracle.pg.rdbms.pgql.PgqlUtils

public class PgqlUtils
extends java.lang.Object

This class contains utility methods for PGQL translation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VT_SUFFIX

Constructor Summary

Constructors

Constructor and Description
PgqlUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	escapeAndEnquoteIdentifier(java.lang.String columnName) Removes all double quotes in the given string and surrounds the whole string with double quotes.
static boolean	extractBooleanOptionValue(java.lang.String options, java.lang.String optionName, boolean defaultValue) Extracts option boolean value of the form OPTION=T or OPTION=F from the given options string.
static boolean	extractBooleanProperty(java.lang.String propName, boolean defaultValue) Extracts the value of a boolean system property and returns it.
static int	extractIntOptionValue(java.lang.String options, java.lang.String optionName, int defaultValue) Extracts option value of the form OPTION=INT_VALUE from the given options string.
static int	extractIntProperty(java.lang.String propName, int defaultValue) Extracts the value of an integer system property and returns it.
static java.lang.String	getDistinctVertexTabName(java.sql.Connection conn, java.lang.String graphOwner, java.lang.String graphName) Returns the fully-qualified distinct vertex table name given the graph name and graph owner name.
static java.lang.String	getEdgeTabName(java.sql.Connection conn, java.lang.String graphOwner, java.lang.String graphName) Returns the fully-qualified edge table name given the graph name and graph owner name.
static java.lang.String	getSkeletonTabName(java.sql.Connection conn, java.lang.String graphOwner, java.lang.String graphName) Returns the fully-qualified skeleton table name given the graph name and graph owner name.
static java.lang.String	getTemporaryTabName(java.sql.Connection conn, java.lang.String graphName, java.lang.String suffix) Returns an enquoted name for a temporary table with prefix ora$ptt_ followed by the given graph name and given suffix.
static java.lang.String	getTemporaryTabName(java.lang.String graphName, java.lang.String suffix) Returns a name for a temporary table with prefix ora$ptt_ followed by the given graph name and given suffix.
static java.lang.String	getVertexTabName(java.sql.Connection conn, java.lang.String graphOwner, java.lang.String graphName) Returns the fully-qualified vertex table name given the graph name and graph owner name.
static void	setModifyOptions(ModifyContext modifyCtx, java.lang.String options) (Re)sets the modify options for this Execution instance.
static void	setQueryOptions(QueryContext ctx, java.lang.String options) (Re)sets the query options for the input QueryContext instance.
static java.lang.String	unescapePgqlString(java.lang.String str) Unescapes constant Strings in a PGQL query for matching against stored versions of the same constant.

Methods inherited from class java.lang.Object

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

Field Detail

VT_SUFFIX

public static final java.lang.String VT_SUFFIX

See Also:

Constant Field Values

Constructor Detail

PgqlUtils

public PgqlUtils()

Method Detail

escapeAndEnquoteIdentifier

public static java.lang.String escapeAndEnquoteIdentifier(java.lang.String columnName)

Removes all double quotes in the given string and surrounds the whole string with double quotes.

Parameters:

columnName - the string to escape

Returns:

the string without double quotes surrounded by double quotes

extractBooleanOptionValue

public static boolean extractBooleanOptionValue(java.lang.String options,
                                                java.lang.String optionName,
                                                boolean defaultValue)

Extracts option boolean value of the form OPTION=T or OPTION=F from the given options string. The caller should ensure that options and optionName are uppercased.

Parameters:

options - the options string to search

optionName - the option to search for

defaultValue - the default value to use if the option is not set

Returns:

the extracted value or default if missing

extractBooleanProperty

public static boolean extractBooleanProperty(java.lang.String propName,
                                             boolean defaultValue)

Extracts the value of a boolean system property and returns it. defaultValue is returned if the system property is not set.

Parameters:

propName - the system property to extract

defaultValue - the default value to use if the property is not set

Returns:

the extracted value or default if missing

extractIntOptionValue

public static int extractIntOptionValue(java.lang.String options,
                                        java.lang.String optionName,
                                        int defaultValue)

Extracts option value of the form OPTION=INT_VALUE from the given options string. The caller should ensure that options and optionName are uppercased.

Parameters:

options - the options string to search

optionName - the option to search for

defaultValue - the default value to use if the option is not set

Returns:

the extracted value or default if missing

extractIntProperty

public static int extractIntProperty(java.lang.String propName,
                                     int defaultValue)

Extracts the value of an integer system property and returns it. defaultValue is returned if the system property is not set.

Parameters:

propName - the system property to extract

defaultValue - the default value to use if the property is not set

Returns:

the extracted value or default if missing

getDistinctVertexTabName

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

Returns the fully-qualified distinct vertex table name given the graph name and graph owner name. The returned table name will have been checked for SQL injection and will be safe to use in SQL statements.

Parameters:

conn - the Oracle database connection to use

graphOwner - the graph owner name

graphName - the graph name

Returns:

the fully-qualified vertex table name

Throws:

java.sql.SQLException - when table name is illegal

getEdgeTabName

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

Returns the fully-qualified edge table name given the graph name and graph owner name. The returned table name will have been checked for SQL injection and will be safe to use in SQL statements.

Parameters:

conn - the Oracle database connection to use

graphOwner - the graph owner name

graphName - the graph name

Returns:

the fully-qualified edge table name

Throws:

java.sql.SQLException - when table name is illegal

getSkeletonTabName

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

Returns the fully-qualified skeleton table name given the graph name and graph owner name. The returned table name will have been checked for SQL injection and will be safe to use in SQL statements.

Parameters:

conn - the Oracle database connection to use

graphOwner - the graph owner name

graphName - the graph name

Returns:

the fully-qualified skeleton table name

Throws:

java.sql.SQLException - when table name is illegal

getTemporaryTabName

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

Returns an enquoted name for a temporary table with prefix ora$ptt_ followed by the given graph name and given suffix.

Parameters:

conn - the Oracle database connection to use

graphName - the graph name

suffix - a suffix for the temporary table name

Returns:

the enquoted temporary table name

Throws:

java.sql.SQLException - when table name is illegal

getTemporaryTabName

public static java.lang.String getTemporaryTabName(java.lang.String graphName,
                                                   java.lang.String suffix)

Returns a name for a temporary table with prefix ora$ptt_ followed by the given graph name and given suffix.

Parameters:

graphName - the graph name

suffix - a suffix for the temporary table name

Returns:

the temporary table name

getVertexTabName

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

Returns the fully-qualified vertex table name given the graph name and graph owner name. The returned table name will have been checked for SQL injection and will be safe to use in SQL statements.

Parameters:

conn - the Oracle database connection to use

graphOwner - the graph owner name

graphName - the graph name

Returns:

the fully-qualified vertex table name

Throws:

java.sql.SQLException - when table name is illegal

setModifyOptions

public static void setModifyOptions(ModifyContext modifyCtx,
                                    java.lang.String options)

(Re)sets the modify options for this Execution instance. Options are set to their default value and then changed based on the System properties and on the input options string.

Parameters:

modifyCtx - the ModifyContext in which to set options

options - the options string to process

setQueryOptions

public static void setQueryOptions(QueryContext ctx,
                                   java.lang.String options)

(Re)sets the query options for the input QueryContext instance. Options are set to their default value and then changed based on the input options string.

Parameters:

ctx - the QueryContext in which to set options

options - the options string to process

unescapePgqlString

public static java.lang.String unescapePgqlString(java.lang.String str)
                                           throws PgqlToSqlException

Unescapes constant Strings in a PGQL query for matching against stored versions of the same constant. \\, \n, \r and \t are unescaped.

Parameters:

str - the String to unescape

Returns:

a new String equal to str with all characters unescaped

Throws:

PgqlToSqlException