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

public abstract Class AbstractActualJPQLQueryFormatter

extends BaseJPQLQueryFormatter
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.jpa.jpql.tools.model.DefaultActualJPQLQueryFormatter, org.eclipse.persistence.jpa.jpql.tools.model.EclipseLinkActualJPQLQueryFormatter
Annotations
@SuppressWarnings:null
Static Imports
org.eclipse.persistence.jpa.jpql.parser.Expression.AND, .Expression.AS, .Expression.BETWEEN, .Expression.CASE, .Expression.COALESCE, .Expression.CONCAT, .Expression.DELETE, .Expression.DISTINCT, .Expression.DIVISION, .Expression.ELSE, .Expression.EMPTY, .Expression.END, .Expression.EQUAL, .Expression.ESCAPE, .Expression.EXISTS, .Expression.FROM, .Expression.FUNC, .Expression.GROUP_BY, .Expression.HAVING, .Expression.IN, .Expression.IS, .Expression.LIKE, .Expression.MEMBER, .Expression.MINUS, .Expression.MULTIPLICATION, .Expression.NEW, .Expression.NOT, .Expression.NULL, .Expression.OF, .Expression.OR, .Expression.ORDER_BY, .Expression.PLUS, .Expression.SELECT, .Expression.SET, .Expression.THEN, .Expression.TREAT, .Expression.UPDATE, .Expression.WHEN, .Expression.WHERE

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 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 (case of JPQL identifiers and the presence of whitespace); false will only match the case sensitivity of the JPQL identifiers.

Author
Pascal Filion
Since
2.4
Version
2.5

Field Summary

Modifier and TypeField and Description
protected final boolean
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; false will only match the case sensitivity of the JPQL identifiers.

Inherited from org.eclipse.persistence.jpa.jpql.tools.model.BaseJPQLQueryFormatter:
COMMACOMMA_SPACELEFT_PARENTHESISRIGHT_PARENTHESISSPACEstylewriter

Constructor Summary

AccessConstructor and Description
protected
AbstractActualJPQLQueryFormatter(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
)

Creates a new AbstractActualJPQLQueryFormatter.

protected
AbstractActualJPQLQueryFormatter(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 AbstractActualJPQLQueryFormatter.

Method Summary

Modifier and TypeMethod and Description
protected void
appendIdentifier(String
The actual JPQL identifier to append to the writer if it's not an empty string
actualIdentifier
,
String
The uppercase constant of the JPQL identifier to append if the actual one is an empty string
identifier
)

Appends the given actual identifier if it's not an empty string, otherwise the second identifier will be appended.

public boolean

Returns:

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
isUsingExactMatch
()

Determines whether the string representation of any given StateObject should reflect the exact string that was parsed.

protected boolean
protected void
protected void
toStringChildren(ListHolderStateObject<? extends StateObject> stateObject, boolean comma)

protected void
protected void
protected void
protected void
protected void
protected void
protected void
protected void
protected boolean
protected void
protected void
protected void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
Inherited from org.eclipse.persistence.jpa.jpql.tools.model.BaseJPQLQueryFormatter:
formatIdentifiergetIdentifierStyletoStringtoStringtoText