org.eclipse.persistence.jpa.jpql.tools.model

Class DefaultActualJPQLQueryFormatter

java.lang.Object

org.eclipse.persistence.jpa.jpql.tools.model.BaseJPQLQueryFormatter

org.eclipse.persistence.jpa.jpql.tools.model.AbstractActualJPQLQueryFormatter

org.eclipse.persistence.jpa.jpql.tools.model.DefaultActualJPQLQueryFormatter

All Implemented Interfaces:

IJPQLQueryFormatter, StateObjectVisitor

public class DefaultActualJPQLQueryFormatter
extends AbstractActualJPQLQueryFormatter

This IJPQLQueryFormatter is used to generate a string representation of a StateObject based on how it was parsed, which means this formatter can only be used when the StateObject was created by parsing a JPQL query because it needs to retrieve parsing information from the corresponding Expression.

It is possible to partially match the JPQL query that was parsed, the value of the exactMatch will determine whether the string representation of any given StateObject should reflect the exact string that was parsed. true will use every bit of information contained in the corresponding Expression to perfectly match what was parsed; false will only match the case sensitivity of the JPQL identifiers.

Version:

2.4

Author:

Pascal Filion

Since:

2.4

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryFormatter

IJPQLQueryFormatter.IdentifierStyle

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.AbstractActualJPQLQueryFormatter

exactMatch

Fields inherited from class org.eclipse.persistence.jpa.jpql.tools.model.BaseJPQLQueryFormatter

COMMA, COMMA_SPACE, LEFT_PARENTHESIS, RIGHT_PARENTHESIS, SPACE, style, writer

Constructor Summary

Constructors

Constructor and Description
DefaultActualJPQLQueryFormatter(boolean exactMatch) Creates a new DefaultActualJPQLQueryFormatter.
DefaultActualJPQLQueryFormatter(boolean exactMatch, IJPQLQueryFormatter.IdentifierStyle style) Creates a new DefaultActualJPQLQueryFormatter.

Method Summary

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.AbstractActualJPQLQueryFormatter

appendIdentifier, isUsingExactMatch, shouldOutput, toStringAggregateFunction, toStringChildren, toStringCompound, toStringDoubleEncapsulated, toStringEncapsulatedIdentificationVariable, toStringFromClause, toStringIdentificationVariableDeclaration, toStringModifyStatement, toStringPathExpression, toStringRangeVariableDeclaration, toStringSelectStatement, toStringSimpleStateObject, toStringSingleEncapsulated, toStringTripleEncapsulated, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.BaseJPQLQueryFormatter

formatIdentifier, getIdentifierStyle, toString, toString, toText

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultActualJPQLQueryFormatter

public DefaultActualJPQLQueryFormatter(boolean exactMatch)

Creates a new DefaultActualJPQLQueryFormatter.

Parameters:

exactMatch - Determines whether the string representation of any given StateObject should reflect the exact string that was parsed: true will use every bit of information contained in the corresponding Expression to perfectly match what was parsed (case of JPQL identifiers and the presence of whitespace); false will only match the case sensitivity of the JPQL identifiers

DefaultActualJPQLQueryFormatter

public DefaultActualJPQLQueryFormatter(boolean exactMatch,
                                       IJPQLQueryFormatter.IdentifierStyle style)

Creates a new DefaultActualJPQLQueryFormatter.

Parameters:

exactMatch - Determines whether the string representation of any given StateObject should reflect the exact string that was parsed: true will use every bit of information contained in the corresponding Expression to perfectly match what was parsed (case of JPQL identifiers and the presence of whitespace); false will only match the case sensitivity of the JPQL identifiers

style - Determines how the JPQL identifiers are written out, which is used if the StateObject was modified after its creation

Throws:

java.lang.NullPointerException - The IdentifierStyle cannot be null