er.extensions

Class ERXExtensions.KeyValueQualifierSQLGenerationSupport

java.lang.Object

com.webobjects.eoaccess.EOQualifierSQLGeneration.Support

er.extensions.ERXExtensions.KeyValueQualifierSQLGenerationSupport

Enclosing class:

ERXExtensions

public static class ERXExtensions.KeyValueQualifierSQLGenerationSupport
extends EOQualifierSQLGeneration.Support

Support class that listens for EOKeyValueQualifiers that have a selector that was registered and uses their support instead. You'll use this mainly to bind queryOperators in display groups.

Author:

ak Added SQL generation fix for EOKeyValueQualifiers in an edge case where the key is a key path (with two or more keys) and the last key is a derived attribute. For example, "customer.fullName" where the last key fullName is defined as: 'firstName || ' ' || lastName., Ricardo Parada

Field Summary

Fields

Modifier and Type	Field and Description
static String	HANDLES_KEY_PATH_WITH_DERIVED_ATTRIBUTE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
KeyValueQualifierSQLGenerationSupport(EOQualifierSQLGeneration.Support old)

Method Summary

Modifier and Type	Method and Description
static EOAttribute	destinationAttribute(EOEntity rootEntity, String keyPath) Returns the last attribute referenced by key path.
static String	formatValueForAttribute(EOSQLExpression e, Object value, EOAttribute attribute)
static boolean	isKeyPathWithDerivedAttributeCase(EOEntity entity, EOQualifier eoqualifier) Normally EOF can handle key value qualifiers with a key corresponding to a derived attribute, i.e.
static NSArray<String>	parseDefinitionPropertyKeys(EOAttribute derivedAttribute) Given the definition of a derived attribute belonging to the entity provided this method parses the definition looking for key paths that represent properties.
EOQualifier	qualifierMigratedFromEntityRelationshipPath(EOQualifier eoqualifier, EOEntity eoentity, String s)
EOQualifier	schemaBasedQualifierWithRootEntity(EOQualifier eoqualifier, EOEntity eoentity)
String	sqlStringForAttributeValue(EOSQLExpression e, EOAttribute att, Object value) Uses the EOSQLExpression provided to get the SQL string for value and corresponding attribute.
String	sqlStringForSQLExpression(EOQualifier eoqualifier, EOSQLExpression e)
String	sqlStringForSQLExpressionWithKeyPathWithDerivedAttribute(EOQualifier eoqualifier, EOSQLExpression e) This method handles an edge case where the key of the qualifier is a key path and the last key in the key path references a derived attribute.

Methods inherited from class com.webobjects.eoaccess.EOQualifierSQLGeneration.Support

_flattenRelationshipPath, _optimizeQualifierKeyPath, _qualifierMigratedFromEntityRelationshipPath, _qualifierMigratedToSubEntityFromParentEntity, _schemaBasedQualifierWithRootEntity, _sqlStringForSQLExpression, _translateKeyAcrossRelationshipPath, setSupportForClass, supportForClass

Methods inherited from class java.lang.Object

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

Field Detail

HANDLES_KEY_PATH_WITH_DERIVED_ATTRIBUTE_PROPERTY_NAME

public static final String HANDLES_KEY_PATH_WITH_DERIVED_ATTRIBUTE_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

KeyValueQualifierSQLGenerationSupport

public KeyValueQualifierSQLGenerationSupport(EOQualifierSQLGeneration.Support old)

Method Detail

sqlStringForSQLExpression

public String sqlStringForSQLExpression(EOQualifier eoqualifier,
                                        EOSQLExpression e)

Specified by:

sqlStringForSQLExpression in class EOQualifierSQLGeneration.Support

sqlStringForSQLExpressionWithKeyPathWithDerivedAttribute

public String sqlStringForSQLExpressionWithKeyPathWithDerivedAttribute(EOQualifier eoqualifier,
                                                                       EOSQLExpression e)

This method handles an edge case where the key of the qualifier is a key path and the last key in the key path references a derived attribute. For example, if the key is "order.customerAge" and customerAge were defined as:

(TRUNC(MONTHS_BETWEEN(orderDate,customer.birthDate)/12,0))

and the key value qualifier was something like "order.customerAge > 50" then this method would generate SQL like this:

(TRUNC(MONTHS_BETWEEN(T1.ORDER_DATE,T2.BIRTH_DATE)/12,0)) > 50

Without this fix EOF ends up throwing an exception.

Parameters:

eoqualifier - An EOKeyValueQualifier with a key that is a key path and the last component in the key path is a derived attribute.

e - The EOSQLExpression participating in the SQL generation.

Returns:

The SQL for the eoqualifier.

sqlStringForAttributeValue

public String sqlStringForAttributeValue(EOSQLExpression e,
                                         EOAttribute att,
                                         Object value)

Uses the EOSQLExpression provided to get the SQL string for value and corresponding attribute.

Parameters:

e - The EOSQLExpression to use to generate the SQL

att - The attribute corresponding to the value passed in

value - The value to convert to SQL

Returns:

The SQL string for the value

formatValueForAttribute

public static String formatValueForAttribute(EOSQLExpression e,
                                             Object value,
                                             EOAttribute attribute)

isKeyPathWithDerivedAttributeCase

public static boolean isKeyPathWithDerivedAttributeCase(EOEntity entity,
                                                        EOQualifier eoqualifier)

Normally EOF can handle key value qualifiers with a key corresponding to a derived attribute, i.e. fullName attribute defined as firstName || ' ' || lastName. However, if the key is a key path, i.e. customer.fullName then EOF throws an exception. This method checks to see if the key in the eoqualifier is a key path and the last key in the key path corresponds to a derived attribute.

Parameters:

entity - The entity where the eoqualifier is rooted

eoqualifier - A qualifier to test

Returns:

true if the eoqualifier is an EOKeyValueQualifier and its key is a key path (with two or more keys) and the last key references a derived attribute.

destinationAttribute

public static EOAttribute destinationAttribute(EOEntity rootEntity,
                                               String keyPath)

Returns the last attribute referenced by key path.

Parameters:

rootEntity - The entity where the key path begins.

keyPath - The key path leading to an attribute.

Returns:

The attribute referenced by the last key in the key path. If the last key in the key path is not an attribute then it returns null.

parseDefinitionPropertyKeys

public static NSArray<String> parseDefinitionPropertyKeys(EOAttribute derivedAttribute)

Given the definition of a derived attribute belonging to the entity provided this method parses the definition looking for key paths that represent properties. For example, a customerAge attribute in a hypothetical Order entity could have a definition of 'TRUNC(MONTHS_BETWEEN(orderDate,customer.birthDate)/12,0)' and you can call this method to get an array containing orderDate and customer.birthDate which are the propertyKeys found in the definition.

Parameters:

derivedAttribute - An EOAttribute with a definition

Returns:

An array with the key paths referenced by the definition of the derived attribute.

schemaBasedQualifierWithRootEntity

public EOQualifier schemaBasedQualifierWithRootEntity(EOQualifier eoqualifier,
                                                      EOEntity eoentity)

Specified by:

schemaBasedQualifierWithRootEntity in class EOQualifierSQLGeneration.Support

qualifierMigratedFromEntityRelationshipPath

public EOQualifier qualifierMigratedFromEntityRelationshipPath(EOQualifier eoqualifier,
                                                               EOEntity eoentity,
                                                               String s)

Specified by:

qualifierMigratedFromEntityRelationshipPath in class EOQualifierSQLGeneration.Support