com.webobjects.jdbcadaptor

Class PostgresqlExpression

java.lang.Object

com.webobjects.eoaccess.EOSQLExpression

com.webobjects.jdbcadaptor.JDBCExpression

com.webobjects.jdbcadaptor.PostgresqlExpression

public class PostgresqlExpression
extends JDBCExpression

Postgres needs special handling of NSData conversion, special escape char, has a regex query selector and handles JOIN clauses correctly.

Author:

ak: Regex, NSData, Giorgio Valoti: refactoring, typecasting, schema building, Arturo Perez: JOIN clauses, David Teran: Timestamps handling, Tim Cummings: case sensitive table and column names, cug: hacks for identifier quoting while creating tables

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PostgresqlExpression.JoinClause Helper class that stores a join definition and helps PostgresqlExpression to assemble the correct join clause.

Nested classes/interfaces inherited from class com.webobjects.eoaccess.EOSQLExpression

EOSQLExpression.SQLValue

Field Summary

Fields

Modifier and Type	Field and Description
static NSSelector	CASE_INSENSITIVE_REGEX_OPERATOR Selector used for case insensitive regular expressions.
static NSSelector	REGEX_OPERATOR Selector used for case sensitive regular expressions.

Fields inherited from class com.webobjects.jdbcadaptor.JDBCExpression

_externalQuoteChar, _inSelect, _jdbcInfo, _rtrimFunctionName

Fields inherited from class com.webobjects.eoaccess.EOSQLExpression

_aliasesByRelationshipPath, _bindings, _contextStack, _defaultDateFormatter, _entity, _joinClauseString, _listString, _NibbleToHex, _orderByString, _statement, _upperFunctionName, _useAliases, _valueListString, _whereClauseString, BindVariableAttributeKey, BindVariableColumnKey, BindVariableNameKey, BindVariablePlaceHolderKey, BindVariableValueKey

Constructor Summary

Constructors

Constructor and Description
PostgresqlExpression(EOEntity entity) Overridden to remove the rtrim usage.

Method Summary

Modifier and Type	Method and Description
void	addCreateClauseForAttribute(EOAttribute attribute)
void	addJoinClause(String leftName, String rightName, int semantic) Overridden to not call the super implementation.
String	allowsNullClauseForConstraint(boolean allowsNull) cug: Quick hack for bug in WebObjects 5.4 where the "not null" statement is added without a space, and "addCreateClauseForAttribute" is not called anymore.
String	assembleJoinClause(String leftName, String rightName, int semantic) Overridden to construct a valid SQL92 JOIN clause as opposed to the Oracle-like SQL the superclass produces.
String	assembleSelectStatementWithAttributes(NSArray attributes, boolean lock, EOQualifier qualifier, NSArray fetchOrder, String selectString, String columnList, String tableList, String whereClause, String joinClause, String orderByClause, String lockClause) Overridden to handle correct placements of join conditions and to handle DISTINCT fetches with compareCaseInsensitiveA(De)scending sort orders.
NSMutableDictionary	bindVariableDictionaryForAttribute(EOAttribute eoattribute, Object obj) Overridden to fix an issue with NStimestamp classes and "T" value-typed attributes.
String	columnTypeStringForAttribute(EOAttribute attribute) Overrides the parent implementation to provide support for array data types.
String	externalNameQuoteCharacter() Overridden because PostgreSQL does not use the default quote character in EOSQLExpression.externalNameQuoteCharacter() which is an empty string.
String	formatValueForAttribute(Object obj, EOAttribute eoattribute) Overridden because the original version throws when the data contains negative byte values.
String	joinClauseString() Overrides the parent implementation to compose the final string expression for the join clauses.
boolean	mustUseBindVariableForAttribute(EOAttribute attribute) Overridden to return true only if bind variables are enabled or the is a data type.
void	prepareConstraintStatementForRelationship(EORelationship relationship, NSArray sourceColumns, NSArray destinationColumns) Overrides the parent implementation to add an INITIALLY DEFERRED to the generated statement.
void	prepareSelectExpressionWithAttributes(NSArray<EOAttribute> attributes, boolean lock, EOFetchSpecification fetchSpec) Overridden so we can get the fetch limit from the fetchSpec.
static String	replaceStringByStringInString(String old, String newString, String buffer) Deprecated. use StringUtils#replace(String, String, String) instead
void	setUseBindVariables(boolean value) Overridden to set the disableBindVariables value correctly.
protected boolean	shouldAllowNull(EOAttribute attribute)
boolean	shouldUseBindVariableForAttribute(EOAttribute attribute) Overridden to return true only if bind variables are enabled or the is a data type.
char	sqlEscapeChar() Overridden because Postgres uses "|" instead of "\" like any other database system.
String	sqlStringForAttribute(EOAttribute attribute) Overridden because the original version does not correctly quote mixed case fields in all cases.
String	sqlStringForData(NSData data) Overridden because the original version throws an exception when the data contains negative byte values.
String	sqlStringForSelector(NSSelector selector, Object value) Overridden so we can put a regex-match qualifier in the display groups query bindings.
String	sqlStringForValue(Object v, String kp) Overrides the parent implementation to: add typecasts after the value, i.e.
String	tableListWithRootEntity(EOEntity entity) Overridden because the original version does not correctly quote mixed case table names in all cases.
boolean	useBindVariables() Overridden to return the negated value of disableBindVariables().

Methods inherited from class com.webobjects.jdbcadaptor.JDBCExpression

addSelectListAttribute, appendItemToListString, appendItemToOrderByString, appendItemToValueListString, jdbcInfo, lockClause, setJDBCInfo

Methods inherited from class com.webobjects.eoaccess.EOSQLExpression

_aliasForRelatedAttributeRelationshipPath, _aliasForRelationshipPath, _defaultDateFormatter, _entityForRelationshipPathOrigin, _flattenRelPathEntity, _listString, _orderByString, _rootEntityForExpression, _setEntity, _sqlStringForJoinSemanticMatchSemantic, _stringForDate, _truncatedString, _truncatedStringForData, _valueList, addBindVariableDictionary, addInsertListAttribute, addOrderByAttributeOrdering, addUpdateListAttribute, aliasesByRelationshipPath, appendItemToListString, assembleDeleteStatementWithQualifier, assembleInsertStatementWithRow, assembleUpdateStatementWithRow, bindVariableDictionaries, entity, formatSQLString, formatStringValue, joinExpression, listString, orderByString, prepareDeleteExpressionForQualifier, prepareInsertExpressionWithRow, prepareUpdateExpressionWithRow, setStatement, setUseAliases, setUseQuotedExternalNames, sqlPatternFromShellPattern, sqlPatternFromShellPatternWithEscapeCharacter, sqlStringForAttributeNamed, sqlStringForAttributePath, sqlStringForCaseInsensitiveLike, sqlStringForConjoinedQualifiers, sqlStringForDisjoinedQualifiers, sqlStringForKeyComparisonQualifier, sqlStringForKeyValueQualifier, sqlStringForNegatedQualifier, sqlStringForNumber, sqlStringForQualifier, sqlStringForSchemaObjectName, sqlStringForString, statement, toString, useAliases, useQuotedExternalNames, valueList, whereClauseString

Methods inherited from class java.lang.Object

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

Field Detail

CASE_INSENSITIVE_REGEX_OPERATOR

public static final NSSelector CASE_INSENSITIVE_REGEX_OPERATOR

Selector used for case insensitive regular expressions.

REGEX_OPERATOR

public static final NSSelector REGEX_OPERATOR

Selector used for case sensitive regular expressions.

Constructor Detail

PostgresqlExpression

public PostgresqlExpression(EOEntity entity)

Overridden to remove the rtrim usage. The original implementation will remove every trailing space from character based column which should not be OK for Postgres.

Method Detail

bindVariableDictionaryForAttribute

public NSMutableDictionary bindVariableDictionaryForAttribute(EOAttribute eoattribute,
                                                              Object obj)

Overridden to fix an issue with NStimestamp classes and "T" value-typed attributes.

Overrides:

bindVariableDictionaryForAttribute in class JDBCExpression

addJoinClause

public void addJoinClause(String leftName,
                          String rightName,
                          int semantic)

Overridden to not call the super implementation.

Overrides:

addJoinClause in class EOSQLExpression

Parameters:

leftName - the table name on the left side of the clause

rightName - the table name on the right side of the clause

semantic - the join semantic

assembleJoinClause

public String assembleJoinClause(String leftName,
                                 String rightName,
                                 int semantic)

Overridden to construct a valid SQL92 JOIN clause as opposed to the Oracle-like SQL the superclass produces.

Overrides:

assembleJoinClause in class EOSQLExpression

Parameters:

leftName - the table name on the left side of the clause

rightName - the table name on the right side of the clause

semantic - the join semantic

Returns:

the join clause

assembleSelectStatementWithAttributes

public String assembleSelectStatementWithAttributes(NSArray attributes,
                                                    boolean lock,
                                                    EOQualifier qualifier,
                                                    NSArray fetchOrder,
                                                    String selectString,
                                                    String columnList,
                                                    String tableList,
                                                    String whereClause,
                                                    String joinClause,
                                                    String orderByClause,
                                                    String lockClause)

Overridden to handle correct placements of join conditions and to handle DISTINCT fetches with compareCaseInsensitiveA(De)scending sort orders.

Overrides:

assembleSelectStatementWithAttributes in class EOSQLExpression

Parameters:

attributes - the attributes to select

lock - flag for locking rows in the database

qualifier - the qualifier to restrict the selection

fetchOrder - specifies the fetch order

columnList - the SQL columns to be fetched

tableList - the the SQL tables to be fetched

whereClause - the SQL where clause

joinClause - the SQL join clause

orderByClause - the SQL sort order clause

lockClause - the SQL lock clause

Returns:

the select statement

columnTypeStringForAttribute

public String columnTypeStringForAttribute(EOAttribute attribute)

Overrides the parent implementation to provide support for array data types.

Overrides:

columnTypeStringForAttribute in class JDBCExpression

Parameters:

attribute - the EOattribute

Returns:

the PostgreSQL specific type string for attribute

formatValueForAttribute

public String formatValueForAttribute(Object obj,
                                      EOAttribute eoattribute)

Overridden because the original version throws when the data contains negative byte values.

Overrides:

formatValueForAttribute in class JDBCExpression

Parameters:

obj - the object used in the SQL statement

eoattribute - the attribute associated with obj

Returns:

the formatted string

joinClauseString

public String joinClauseString()

Overrides the parent implementation to compose the final string expression for the join clauses.

Overrides:

joinClauseString in class EOSQLExpression

prepareConstraintStatementForRelationship

public void prepareConstraintStatementForRelationship(EORelationship relationship,
                                                      NSArray sourceColumns,
                                                      NSArray destinationColumns)

Overrides the parent implementation to add an INITIALLY DEFERRED to the generated statement. Useful you want to generate the schema-building SQL from a pure java environment. cug: Also handles identifier quoting now

Overrides:

prepareConstraintStatementForRelationship in class EOSQLExpression

Parameters:

relationship - the relationship

sourceColumns - the source columns for the constraints

destinationColumns - the destination columns for the constraints

prepareSelectExpressionWithAttributes

public void prepareSelectExpressionWithAttributes(NSArray<EOAttribute> attributes,
                                                  boolean lock,
                                                  EOFetchSpecification fetchSpec)

Overridden so we can get the fetch limit from the fetchSpec.

Overrides:

prepareSelectExpressionWithAttributes in class JDBCExpression

Parameters:

attributes - the array of attributes

lock - locking flag

fetchSpec - the fetch specification

sqlEscapeChar

public char sqlEscapeChar()

Overridden because Postgres uses "|" instead of "\" like any other database system.

Overrides:

sqlEscapeChar in class EOSQLExpression

externalNameQuoteCharacter

public String externalNameQuoteCharacter()

Overridden because PostgreSQL does not use the default quote character in EOSQLExpression.externalNameQuoteCharacter() which is an empty string.

Overrides:

externalNameQuoteCharacter in class JDBCExpression

shouldAllowNull

protected boolean shouldAllowNull(EOAttribute attribute)

addCreateClauseForAttribute

public void addCreateClauseForAttribute(EOAttribute attribute)

Overrides:

addCreateClauseForAttribute in class EOSQLExpression

allowsNullClauseForConstraint

public String allowsNullClauseForConstraint(boolean allowsNull)

cug: Quick hack for bug in WebObjects 5.4 where the "not null" statement is added without a space, and "addCreateClauseForAttribute" is not called anymore. Will probably change.

Overrides:

allowsNullClauseForConstraint in class JDBCExpression

sqlStringForAttribute

public String sqlStringForAttribute(EOAttribute attribute)

Overridden because the original version does not correctly quote mixed case fields in all cases. SELECT statements were OK (useAliases is true) INSERT, UPDATE, DELETE didn't quote mixed case field names.

Overrides:

sqlStringForAttribute in class EOSQLExpression

Parameters:

attribute - the attribute (column name) to be converted to a SQL string

Returns:

SQL string for the attribute

tableListWithRootEntity

public String tableListWithRootEntity(EOEntity entity)

Overridden because the original version does not correctly quote mixed case table names in all cases. SELECT statements were OK (useAliases is true) INSERT, UPDATE, DELETE didn't quote mixed case field names.

Overrides:

tableListWithRootEntity in class EOSQLExpression

Returns:

the SQL string for the table names

sqlStringForData

public String sqlStringForData(NSData data)

Overridden because the original version throws an exception when the data contains negative byte values. This method is only for smaller values like binary primary keys or such.

Overrides:

sqlStringForData in class EOSQLExpression

Parameters:

data - the data to be converted to a SQL string

Returns:

the SQL string for raw data

sqlStringForSelector

public String sqlStringForSelector(NSSelector selector,
                                   Object value)

Overridden so we can put a regex-match qualifier in the display groups query bindings. You can bind '~*' or '~' to queryOperator.someKey and '.*foo' to queryMatch.someKey and will get the correct results.

Overrides:

sqlStringForSelector in class EOSQLExpression

Parameters:

selector - the selector that specifies the SQL operator

value - the value to be associated with selector

Returns:

the SQL operator string

sqlStringForValue

public String sqlStringForValue(Object v,
                                String kp)

Overrides the parent implementation to:

• add typecasts after the value, i.e. '2'::char, which is required with certain PostgreSQL versions (<=7.4.x) for the correct query processing, particularly with index usage.
• quotes values if bind variables are disabled on this attribute.

NULL values are excluded from casting.

You can set the System default com.webobjects.jdbcadaptor.PostgresqlExpression.disableTypeCasting to true to disable both fixes (the former you might want to disable when PG says it can't cast a certain value and the second when you have values with a greater resolution already in the DB).

Overrides:

sqlStringForValue in class EOSQLExpression

Parameters:

v - the value

kp - the keypath associated with the value

useBindVariables

public boolean useBindVariables()

Overridden to return the negated value of disableBindVariables().

Overrides:

useBindVariables in class JDBCExpression

setUseBindVariables

public void setUseBindVariables(boolean value)

Overridden to set the disableBindVariables value correctly.

Overrides:

setUseBindVariables in class EOSQLExpression

Parameters:

value -

shouldUseBindVariableForAttribute

public boolean shouldUseBindVariableForAttribute(EOAttribute attribute)

Overridden to return true only if bind variables are enabled or the is a data type.

Overrides:

shouldUseBindVariableForAttribute in class JDBCExpression

mustUseBindVariableForAttribute

public boolean mustUseBindVariableForAttribute(EOAttribute attribute)

Overridden to return true only if bind variables are enabled or the is a data type.

Overrides:

mustUseBindVariableForAttribute in class JDBCExpression

replaceStringByStringInString

public static String replaceStringByStringInString(String old,
                                                   String newString,
                                                   String buffer)

Deprecated. use StringUtils#replace(String, String, String) instead

Replaces a given string by another string in a string.

Parameters:

old - string to be replaced

newString - to be inserted

buffer - string to have the replacement done on it

Returns:

string after having all of the replacement done.