Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.tools.model

public Class EclipseLinkActualJPQLQueryFormatter

extends AbstractActualJPQLQueryFormatter
implements EclipseLinkStateObjectVisitor
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.jpa.jpql.tools.model.query.EclipseLinkStateObjectVisitor, org.eclipse.persistence.jpa.jpql.tools.model.query.StateObjectVisitor
Imports
org.eclipse.persistence.jpa.jpql.tools.model.query.EclipseLinkStateObjectVisitor

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.

This version adds support for EclipseLink extension.

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.

Author
Pascal Filion
Since
2.4
Version
2.4

Field Summary

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.AbstractActualJPQLQueryFormatter:
exactMatch

Constructor Summary

AccessConstructor and Description
public
EclipseLinkActualJPQLQueryFormatter(boolean
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; false will only match the case sensitivity of the JPQL identifiers
exactMatch
)

Creates a new EclipseLinkActualJPQLQueryFormatter.

public
EclipseLinkActualJPQLQueryFormatter(boolean
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
exactMatch
,
IJPQLQueryFormatter.IdentifierStyle
Determines how the JPQL identifiers are written out, which is used if the StateObject was modified after its creation
style
)

Creates a new EclipseLinkActualJPQLQueryFormatter.

Method Summary

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.AbstractActualJPQLQueryFormatter:
appendIdentifierisUsingExactMatchshouldOutputtoStringAggregateFunctiontoStringChildrentoStringCompoundtoStringDoubleEncapsulatedtoStringEncapsulatedIdentificationVariabletoStringFromClausetoStringIdentificationVariableDeclarationtoStringModifyStatementtoStringPathExpressiontoStringRangeVariableDeclarationtoStringSelectStatementtoStringSimpleStateObjecttoStringSingleEncapsulatedtoStringTripleEncapsulatedvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisit

Constructor Detail

EclipseLinkActualJPQLQueryFormatterback to summary
public EclipseLinkActualJPQLQueryFormatter(boolean exactMatch)

Creates a new EclipseLinkActualJPQLQueryFormatter.

Parameters
exactMatch:boolean

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; false will only match the case sensitivity of the JPQL identifiers

EclipseLinkActualJPQLQueryFormatterback to summary
public EclipseLinkActualJPQLQueryFormatter(boolean exactMatch, IJPQLQueryFormatter.IdentifierStyle style)

Creates a new EclipseLinkActualJPQLQueryFormatter.

Parameters
exactMatch:boolean

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:IJPQLQueryFormatter.IdentifierStyle

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

Exceptions
NullPointerException:
The IdentifierStyle cannot be null