public abstract class AbstractActualJPQLQueryFormatter extends BaseJPQLQueryFormatter
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.
IJPQLQueryFormatter.IdentifierStyle
Modifier and Type | Field and Description |
---|---|
protected 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. |
COMMA, COMMA_SPACE, LEFT_PARENTHESIS, RIGHT_PARENTHESIS, SPACE, style, writer
Modifier | Constructor and Description |
---|---|
protected |
AbstractActualJPQLQueryFormatter(boolean exactMatch)
Creates a new
AbstractActualJPQLQueryFormatter . |
protected |
AbstractActualJPQLQueryFormatter(boolean exactMatch,
IJPQLQueryFormatter.IdentifierStyle style)
Creates a new
AbstractActualJPQLQueryFormatter . |
formatIdentifier, getIdentifierStyle, toString, toString, toText
protected final boolean exactMatch
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.protected AbstractActualJPQLQueryFormatter(boolean exactMatch)
AbstractActualJPQLQueryFormatter
.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 identifiersprotected AbstractActualJPQLQueryFormatter(boolean exactMatch, IJPQLQueryFormatter.IdentifierStyle style)
AbstractActualJPQLQueryFormatter
.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 identifiersstyle
- Determines how the JPQL identifiers are written out, which is used if the
StateObject
was modified after its creationjava.lang.NullPointerException
- The IdentifierStyle cannot be null
protected void appendIdentifier(java.lang.String actualIdentifier, java.lang.String identifier)
actualIdentifier
- The actual JPQL identifier to append to the writer if it's not an
empty stringidentifier
- The uppercase constant of the JPQL identifier to append if the actual one is
an empty stringpublic boolean isUsingExactMatch()
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 identifiersprotected boolean shouldOutput(Expression expression)
protected void toStringAggregateFunction(AggregateFunctionStateObject stateObject)
protected void toStringChildren(ListHolderStateObject<? extends StateObject> stateObject, boolean comma)
protected void toStringCompound(CompoundExpressionStateObject stateObject, java.lang.String identifier)
protected void toStringDoubleEncapsulated(AbstractDoubleEncapsulatedExpressionStateObject stateObject)
protected void toStringEncapsulatedIdentificationVariable(EncapsulatedIdentificationVariableExpressionStateObject stateObject)
protected void toStringFromClause(AbstractFromClauseStateObject stateObject)
protected void toStringIdentificationVariableDeclaration(AbstractIdentificationVariableDeclarationStateObject stateObject)
protected void toStringModifyStatement(AbstractModifyStatementStateObject stateObject)
protected void toStringPathExpression(AbstractPathExpressionStateObject stateObject)
protected void toStringRangeVariableDeclaration(AbstractRangeVariableDeclarationStateObject stateObject)
protected boolean toStringSelectStatement(AbstractSelectStatementStateObject stateObject)
protected void toStringSimpleStateObject(SimpleStateObject stateObject)
protected void toStringSingleEncapsulated(AbstractSingleEncapsulatedExpressionStateObject stateObject)
protected void toStringTripleEncapsulated(AbstractTripleEncapsulatedExpressionStateObject stateObject)
public void visit(AbsExpressionStateObject stateObject)
AbsExpressionStateObject
.stateObject
- The AbsExpressionStateObject
to visitpublic void visit(AbstractSchemaNameStateObject stateObject)
AbstractSchemaNameStateObject
.stateObject
- The AbstractSchemaNameStateObject
to visitpublic void visit(AdditionExpressionStateObject stateObject)
AdditionExpressionStateObject
.stateObject
- The AdditionExpressionStateObject
to visitpublic void visit(AllOrAnyExpressionStateObject stateObject)
AllOrAnyExpressionStateObject
.stateObject
- The AllOrAnyExpressionStateObject
to visitpublic void visit(AndExpressionStateObject stateObject)
AndExpressionStateObject
.stateObject
- The AndExpressionStateObject
to visitpublic void visit(ArithmeticFactorStateObject stateObject)
ArithmeticFactorStateObject
.stateObject
- The ArithmeticFactorStateObject
to visitpublic void visit(AvgFunctionStateObject stateObject)
AvgFunctionStateObject
.stateObject
- The AvgFunctionStateObject
to visitpublic void visit(BadExpressionStateObject stateObject)
BadExpressionStateObject
.stateObject
- The BadExpressionStateObject
to visitpublic void visit(BetweenExpressionStateObject stateObject)
BetweenExpressionStateObject
.stateObject
- The BetweenExpressionStateObject
to visitpublic void visit(CaseExpressionStateObject stateObject)
CaseExpressionStateObject
.stateObject
- The CaseExpressionStateObject
to visitpublic void visit(CoalesceExpressionStateObject stateObject)
CoalesceExpressionStateObject
.stateObject
- The CoalesceExpressionStateObject
to visitpublic void visit(CollectionMemberDeclarationStateObject stateObject)
CollectionMemberDeclarationStateObject
.stateObject
- The CollectionMemberDeclarationStateObject
to visitpublic void visit(CollectionMemberExpressionStateObject stateObject)
CollectionMemberExpressionStateObject
.stateObject
- The CollectionMemberExpressionStateObject
to visitpublic void visit(CollectionValuedPathExpressionStateObject stateObject)
CollectionValuedPathExpressionStateObject
.stateObject
- The CollectionValuedPathExpressionStateObject
to visitpublic void visit(ComparisonExpressionStateObject stateObject)
ComparisonExpressionStateObject
.stateObject
- The ComparisonExpressionStateObject
to visitpublic void visit(ConcatExpressionStateObject stateObject)
ConcatExpressionStateObject
.stateObject
- The ConcatExpressionStateObject
to visitpublic void visit(ConstructorExpressionStateObject stateObject)
ConstructorExpressionStateObject
.stateObject
- The ConstructorExpressionStateObject
to visitpublic void visit(CountFunctionStateObject stateObject)
CountFunctionStateObject
.stateObject
- The CountFunctionStateObject
to visitpublic void visit(DateTimeStateObject stateObject)
DateTimeStateObject
.stateObject
- The DateTimeStateObject
to visitpublic void visit(DeleteClauseStateObject stateObject)
DeleteClauseStateObject
.stateObject
- The DeleteClauseStateObject
to visitpublic void visit(DeleteStatementStateObject stateObject)
DeleteStatementStateObject
.stateObject
- The DeleteStatementStateObject
to visitpublic void visit(DerivedPathIdentificationVariableDeclarationStateObject stateObject)
DerivedPathIdentificationVariableDeclarationStateObject
.stateObject
- The DerivedPathIdentificationVariableDeclarationStateObject
to visitpublic void visit(DerivedPathVariableDeclarationStateObject stateObject)
DerivedPathVariableDeclarationStateObject
.stateObject
- The DerivedPathVariableDeclarationStateObject
to visitpublic void visit(DivisionExpressionStateObject stateObject)
DivisionExpressionStateObject
.stateObject
- The DivisionExpressionStateObject
to visitpublic void visit(EmptyCollectionComparisonExpressionStateObject stateObject)
EmptyCollectionComparisonExpressionStateObject
.stateObject
- The EmptyCollectionComparisonExpressionStateObject
to visitpublic void visit(EntityTypeLiteralStateObject stateObject)
EntityTypeLiteralStateObject
.stateObject
- The EntityTypeLiteralStateObject
to visitpublic void visit(EntryExpressionStateObject stateObject)
EntryExpressionStateObject
.stateObject
- The EntryExpressionStateObject
to visitpublic void visit(EnumTypeStateObject stateObject)
EnumTypeStateObject
.stateObject
- The EnumTypeStateObject
to visitpublic void visit(ExistsExpressionStateObject stateObject)
ExistsExpressionStateObject
.stateObject
- The ExistsExpressionStateObject
to visitpublic void visit(FromClauseStateObject stateObject)
FromClauseStateObject
.stateObject
- The FromClauseStateObject
to visitpublic void visit(FunctionExpressionStateObject stateObject)
FunctionExpressionStateObject
.stateObject
- The FunctionExpressionStateObject
to visitpublic void visit(GroupByClauseStateObject stateObject)
GroupByClauseStateObject
.stateObject
- The GroupByClauseStateObject
to visitpublic void visit(HavingClauseStateObject stateObject)
HavingClauseStateObject
.stateObject
- The HavingClauseStateObject
to visitpublic void visit(IdentificationVariableDeclarationStateObject stateObject)
IdentificationVariableDeclarationStateObject
.stateObject
- The IdentificationVariableDeclarationStateObject
to visitpublic void visit(IdentificationVariableStateObject stateObject)
IdentificationVariableStateObject
.stateObject
- The IdentificationVariableStateObject
to visitpublic void visit(IndexExpressionStateObject stateObject)
IndexExpressionStateObject
.stateObject
- The IndexExpressionStateObject
to visitpublic void visit(InExpressionStateObject stateObject)
InExpressionStateObject
.stateObject
- The InExpressionStateObject
to visitpublic void visit(InputParameterStateObject stateObject)
InputParameterStateObject
.stateObject
- The InputParameterStateObject
to visitpublic void visit(JoinStateObject stateObject)
JoinStateObject
.stateObject
- The JPQLQueryStateObject
to visitpublic void visit(JPQLQueryStateObject stateObject)
JPQLQueryStateObject
.stateObject
- The JPQLQueryStateObject
to visitpublic void visit(KeyExpressionStateObject stateObject)
KeyExpressionStateObject
.stateObject
- The KeyExpressionStateObject
to visitpublic void visit(KeywordExpressionStateObject stateObject)
KeywordExpressionStateObject
.stateObject
- The KeywordExpressionStateObject
to visitpublic void visit(LengthExpressionStateObject stateObject)
LengthExpressionStateObject
.stateObject
- The LengthExpressionStateObject
to visitpublic void visit(LikeExpressionStateObject stateObject)
LikeExpressionStateObject
.stateObject
- The LikeExpressionStateObject
to visitpublic void visit(LocateExpressionStateObject stateObject)
LocateExpressionStateObject
.stateObject
- The LocateExpressionStateObject
to visitpublic void visit(LowerExpressionStateObject stateObject)
LowerExpressionStateObject
.stateObject
- The LowerExpressionStateObject
to visitpublic void visit(MaxFunctionStateObject stateObject)
MaxFunctionStateObject
.stateObject
- The MaxFunctionStateObject
to visitpublic void visit(MinFunctionStateObject stateObject)
WhereClauseStateObject
.stateObject
- The WhereClauseStateObject
to visitpublic void visit(ModExpressionStateObject stateObject)
ModExpressionStateObject
.stateObject
- The ModExpressionStateObject
to visitpublic void visit(MultiplicationExpressionStateObject stateObject)
MultiplicationExpressionStateObject
.stateObject
- The MultiplicationExpressionStateObject
to visitpublic void visit(NotExpressionStateObject stateObject)
NotExpressionStateObject
.stateObject
- The NotExpressionStateObject
to visitpublic void visit(NullComparisonExpressionStateObject stateObject)
NullComparisonExpressionStateObject
.stateObject
- The NullComparisonExpressionStateObject
to visitpublic void visit(NullIfExpressionStateObject stateObject)
NullIfExpressionStateObject
.stateObject
- The NullIfExpressionStateObject
to visitpublic void visit(NumericLiteralStateObject stateObject)
NumericLiteralStateObject
.stateObject
- The NumericLiteralStateObject
to visitpublic void visit(ObjectExpressionStateObject stateObject)
ObjectExpressionStateObject
.stateObject
- The ObjectExpressionStateObject
to visitpublic void visit(OrderByClauseStateObject stateObject)
OrderByClauseStateObject
.stateObject
- The OrderByClauseStateObject
to visitpublic void visit(OrderByItemStateObject stateObject)
OrderByItemStateObject
.stateObject
- The OrderByItemStateObject
to visitpublic void visit(OrExpressionStateObject stateObject)
OrExpressionStateObject
.stateObject
- The OrExpressionStateObject
to visitpublic void visit(RangeVariableDeclarationStateObject stateObject)
RangeVariableDeclarationStateObject
.stateObject
- The RangeVariableDeclarationStateObject
to visitpublic void visit(ResultVariableStateObject stateObject)
ResultVariableStateObject
.stateObject
- The ResultVariableStateObject
to visitpublic void visit(SelectClauseStateObject stateObject)
SelectClauseStateObject
.stateObject
- The SelectClauseStateObject
to visitpublic void visit(SelectStatementStateObject stateObject)
SelectStatementStateObject
.stateObject
- The SelectStatementStateObject
to visitpublic void visit(SimpleFromClauseStateObject stateObject)
SimpleFromClauseStateObject
.stateObject
- The SimpleFromClauseStateObject
to visitpublic void visit(SimpleSelectClauseStateObject stateObject)
SimpleSelectClauseStateObject
.stateObject
- The SimpleSelectClauseStateObject
to visitpublic void visit(SimpleSelectStatementStateObject stateObject)
SimpleSelectStatementStateObject
.stateObject
- The SimpleSelectStatementStateObject
to visitpublic void visit(SizeExpressionStateObject stateObject)
SizeExpressionStateObject
.stateObject
- The SizeExpressionStateObject
to visitpublic void visit(SqrtExpressionStateObject stateObject)
SqrtExpressionStateObject
.stateObject
- The SqrtExpressionStateObject
to visitpublic void visit(StateFieldPathExpressionStateObject stateObject)
StateFieldPathExpressionStateObject
.stateObject
- The StateFieldPathExpressionStateObject
to visitpublic void visit(StringLiteralStateObject stateObject)
StringLiteralStateObject
.stateObject
- The StringLiteralStateObject
to visitpublic void visit(SubExpressionStateObject stateObject)
SubExpressionStateObject
.stateObject
- The SubExpressionStateObject
to visitpublic void visit(SubstringExpressionStateObject stateObject)
SubstringExpressionStateObject
.stateObject
- The SubstringExpressionStateObject
to visitpublic void visit(SubtractionExpressionStateObject stateObject)
SubtractionExpressionStateObject
.stateObject
- The SubtractionExpressionStateObject
to visitpublic void visit(SumFunctionStateObject stateObject)
SumFunctionStateObject
.stateObject
- The SumFunctionStateObject
to visitpublic void visit(TreatExpressionStateObject stateObject)
TreatExpressionStateObject
.stateObject
- The TreatExpressionStateObject
to visitpublic void visit(TrimExpressionStateObject stateObject)
TrimExpressionStateObject
.stateObject
- The TrimExpressionStateObject
to visitpublic void visit(TypeExpressionStateObject stateObject)
TypeExpressionStateObject
.stateObject
- The TypeExpressionStateObject
to visitpublic void visit(UnknownExpressionStateObject stateObject)
UnknownExpressionStateObject
.stateObject
- The UnknownExpressionStateObject
to visitpublic void visit(UpdateClauseStateObject stateObject)
UpdateClauseStateObject
.stateObject
- The UpdateClauseStateObject
to visitpublic void visit(UpdateItemStateObject stateObject)
UpdateItemStateObject
.stateObject
- The UpdateItemStateObject
to visitpublic void visit(UpdateStatementStateObject stateObject)
UpdateStatementStateObject
.stateObject
- The UpdateStatementStateObject
to visitpublic void visit(UpperExpressionStateObject stateObject)
UpperExpressionStateObject
.stateObject
- The UpperExpressionStateObject
to visitpublic void visit(ValueExpressionStateObject stateObject)
ValueExpressionStateObject
.stateObject
- The ValueExpressionStateObject
to visitpublic void visit(WhenClauseStateObject stateObject)
WhenClauseStateObject
.stateObject
- The WhenClauseStateObject
to visitpublic void visit(WhereClauseStateObject stateObject)
WhereClauseStateObject
.stateObject
- The WhereClauseStateObject
to visit