AbstractActualJPQLQueryFormatter (EclipseLink 2.4.2, build 'v20130514-5956486' API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  org.eclipse.persistence.jpa.jpql.model.BaseJPQLQueryFormatter
      org.eclipse.persistence.jpa.jpql.model.AbstractActualJPQLQueryFormatter

All Implemented Interfaces:: IJPQLQueryFormatter, StateObjectVisitor

Direct Known Subclasses:: DefaultActualJPQLQueryFormatter, EclipseLinkActualJPQLQueryFormatter

public abstract class AbstractActualJPQLQueryFormatter
extends BaseJPQLQueryFormatter
extends BaseJPQLQueryFormatter

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.

Version:: 2.4
Author:: Pascal Filion
Since:: 2.4

Nested Class Summary

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

Field Summary
`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.

Fields inherited from class org.eclipse.persistence.jpa.jpql.model.BaseJPQLQueryFormatter
`COMMA, COMMA_SPACE, LEFT_PARENTHESIS, RIGHT_PARENTHESIS, SPACE, style, writer`

Constructor Summary
`protected`	`AbstractActualJPQLQueryFormatter(boolean exactMatch)` Creates a new `AbstractActualJPQLQueryFormatter`.
`protected`	`AbstractActualJPQLQueryFormatter(boolean exactMatch, IJPQLQueryFormatter.IdentifierStyle style)` Creates a new `AbstractActualJPQLQueryFormatter`.

Method Summary
`protected void`	`appendIdentifier(java.lang.String actualIdentifier, java.lang.String identifier)` Appends the given actual identifier if it's not an empty string, otherwise the second identifier will be appended.
`boolean`	`isUsingExactMatch()` Determines whether the string representation of any given `StateObject` should reflect the exact string that was parsed.
`protected 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)`
`void`	`visit(AbsExpressionStateObject stateObject)` Visits the given `AbsExpressionStateObject`.
`void`	`visit(AbstractSchemaNameStateObject stateObject)` Visits the given `AbstractSchemaNameStateObject`.
`void`	`visit(AdditionExpressionStateObject stateObject)` Visits the given `AdditionExpressionStateObject`.
`void`	`visit(AllOrAnyExpressionStateObject stateObject)` Visits the given `AllOrAnyExpressionStateObject`.
`void`	`visit(AndExpressionStateObject stateObject)` Visits the given `AndExpressionStateObject`.
`void`	`visit(ArithmeticFactorStateObject stateObject)` Visits the given `ArithmeticFactorStateObject`.
`void`	`visit(AvgFunctionStateObject stateObject)` Visits the given `AvgFunctionStateObject`.
`void`	`visit(BadExpressionStateObject stateObject)` Visits the given `BadExpressionStateObject`.
`void`	`visit(BetweenExpressionStateObject stateObject)` Visits the given `BetweenExpressionStateObject`.
`void`	`visit(CaseExpressionStateObject stateObject)` Visits the given `CaseExpressionStateObject`.
`void`	`visit(CoalesceExpressionStateObject stateObject)` Visits the given `CoalesceExpressionStateObject`.
`void`	`visit(CollectionMemberDeclarationStateObject stateObject)` Visits the given `CollectionMemberDeclarationStateObject`.
`void`	`visit(CollectionMemberExpressionStateObject stateObject)` Visits the given `CollectionMemberExpressionStateObject`.
`void`	`visit(CollectionValuedPathExpressionStateObject stateObject)` Visits the given `CollectionValuedPathExpressionStateObject`.
`void`	`visit(ComparisonExpressionStateObject stateObject)` Visits the given `ComparisonExpressionStateObject`.
`void`	`visit(ConcatExpressionStateObject stateObject)` Visits the given `ConcatExpressionStateObject`.
`void`	`visit(ConstructorExpressionStateObject stateObject)` Visits the given `ConstructorExpressionStateObject`.
`void`	`visit(CountFunctionStateObject stateObject)` Visits the given `CountFunctionStateObject`.
`void`	`visit(DateTimeStateObject stateObject)` Visits the given `DateTimeStateObject`.
`void`	`visit(DeleteClauseStateObject stateObject)` Visits the given `DeleteClauseStateObject`.
`void`	`visit(DeleteStatementStateObject stateObject)` Visits the given `DeleteStatementStateObject`.
`void`	`visit(DerivedPathIdentificationVariableDeclarationStateObject stateObject)` Visits the given `DerivedPathIdentificationVariableDeclarationStateObject`.
`void`	`visit(DerivedPathVariableDeclarationStateObject stateObject)` Visits the given `DerivedPathVariableDeclarationStateObject`.
`void`	`visit(DivisionExpressionStateObject stateObject)` Visits the given `DivisionExpressionStateObject`.
`void`	`visit(EmptyCollectionComparisonExpressionStateObject stateObject)` Visits the given `EmptyCollectionComparisonExpressionStateObject`.
`void`	`visit(EntityTypeLiteralStateObject stateObject)` Visits the given `EntityTypeLiteralStateObject`.
`void`	`visit(EntryExpressionStateObject stateObject)` Visits the given `EntryExpressionStateObject`.
`void`	`visit(EnumTypeStateObject stateObject)` Visits the given `EnumTypeStateObject`.
`void`	`visit(ExistsExpressionStateObject stateObject)` Visits the given `ExistsExpressionStateObject`.
`void`	`visit(FromClauseStateObject stateObject)` Visits the given `FromClauseStateObject`.
`void`	`visit(FunctionExpressionStateObject stateObject)` Visits the given `FunctionExpressionStateObject`.
`void`	`visit(GroupByClauseStateObject stateObject)` Visits the given `GroupByClauseStateObject`.
`void`	`visit(HavingClauseStateObject stateObject)` Visits the given `HavingClauseStateObject`.
`void`	`visit(IdentificationVariableDeclarationStateObject stateObject)` Visits the given `IdentificationVariableDeclarationStateObject`.
`void`	`visit(IdentificationVariableStateObject stateObject)` Visits the given `IdentificationVariableStateObject`.
`void`	`visit(IndexExpressionStateObject stateObject)` Visits the given `IndexExpressionStateObject`.
`void`	`visit(InExpressionStateObject stateObject)` Visits the given `InExpressionStateObject`.
`void`	`visit(InputParameterStateObject stateObject)` Visits the given `InputParameterStateObject`.
`void`	`visit(JoinStateObject stateObject)` Visits the given `JoinStateObject`.
`void`	`visit(JPQLQueryStateObject stateObject)` Visits the given `JPQLQueryStateObject`.
`void`	`visit(KeyExpressionStateObject stateObject)` Visits the given `KeyExpressionStateObject`.
`void`	`visit(KeywordExpressionStateObject stateObject)` Visits the given `KeywordExpressionStateObject`.
`void`	`visit(LengthExpressionStateObject stateObject)` Visits the given `LengthExpressionStateObject`.
`void`	`visit(LikeExpressionStateObject stateObject)` Visits the given `LikeExpressionStateObject`.
`void`	`visit(LocateExpressionStateObject stateObject)` Visits the given `LocateExpressionStateObject`.
`void`	`visit(LowerExpressionStateObject stateObject)` Visits the given `LowerExpressionStateObject`.
`void`	`visit(MaxFunctionStateObject stateObject)` Visits the given `MaxFunctionStateObject`.
`void`	`visit(MinFunctionStateObject stateObject)` Visits the given `WhereClauseStateObject`.
`void`	`visit(ModExpressionStateObject stateObject)` Visits the given `ModExpressionStateObject`.
`void`	`visit(MultiplicationExpressionStateObject stateObject)` Visits the given `MultiplicationExpressionStateObject`.
`void`	`visit(NotExpressionStateObject stateObject)` Visits the given `NotExpressionStateObject`.
`void`	`visit(NullComparisonExpressionStateObject stateObject)` Visits the given `NullComparisonExpressionStateObject`.
`void`	`visit(NullIfExpressionStateObject stateObject)` Visits the given `NullIfExpressionStateObject`.
`void`	`visit(NumericLiteralStateObject stateObject)` Visits the given `NumericLiteralStateObject`.
`void`	`visit(ObjectExpressionStateObject stateObject)` Visits the given `ObjectExpressionStateObject`.
`void`	`visit(OrderByClauseStateObject stateObject)` Visits the given `OrderByClauseStateObject`.
`void`	`visit(OrderByItemStateObject stateObject)` Visits the given `OrderByItemStateObject`.
`void`	`visit(OrExpressionStateObject stateObject)` Visits the given `OrExpressionStateObject`.
`void`	`visit(RangeVariableDeclarationStateObject stateObject)` Visits the given `RangeVariableDeclarationStateObject`.
`void`	`visit(ResultVariableStateObject stateObject)` Visits the given `ResultVariableStateObject`.
`void`	`visit(SelectClauseStateObject stateObject)` Visits the given `SelectClauseStateObject`.
`void`	`visit(SelectStatementStateObject stateObject)` Visits the given `SelectStatementStateObject`.
`void`	`visit(SimpleFromClauseStateObject stateObject)` Visits the given `SimpleFromClauseStateObject`.
`void`	`visit(SimpleSelectClauseStateObject stateObject)` Visits the given `SimpleSelectClauseStateObject`.
`void`	`visit(SimpleSelectStatementStateObject stateObject)` Visits the given `SimpleSelectStatementStateObject`.
`void`	`visit(SizeExpressionStateObject stateObject)` Visits the given `SizeExpressionStateObject`.
`void`	`visit(SqrtExpressionStateObject stateObject)` Visits the given `SqrtExpressionStateObject`.
`void`	`visit(StateFieldPathExpressionStateObject stateObject)` Visits the given `StateFieldPathExpressionStateObject`.
`void`	`visit(StringLiteralStateObject stateObject)` Visits the given `StringLiteralStateObject`.
`void`	`visit(SubExpressionStateObject stateObject)` Visits the given `SubExpressionStateObject`.
`void`	`visit(SubstringExpressionStateObject stateObject)` Visits the given `SubstringExpressionStateObject`.
`void`	`visit(SubtractionExpressionStateObject stateObject)` Visits the given `SubtractionExpressionStateObject`.
`void`	`visit(SumFunctionStateObject stateObject)` Visits the given `SumFunctionStateObject`.
`void`	`visit(TreatExpressionStateObject stateObject)` Visits the given `TreatExpressionStateObject`.
`void`	`visit(TrimExpressionStateObject stateObject)` Visits the given `TrimExpressionStateObject`.
`void`	`visit(TypeExpressionStateObject stateObject)` Visits the given `TypeExpressionStateObject`.
`void`	`visit(UnknownExpressionStateObject stateObject)` Visits the given `UnknownExpressionStateObject`.
`void`	`visit(UpdateClauseStateObject stateObject)` Visits the given `UpdateClauseStateObject`.
`void`	`visit(UpdateItemStateObject stateObject)` Visits the given `UpdateItemStateObject`.
`void`	`visit(UpdateStatementStateObject stateObject)` Visits the given `UpdateStatementStateObject`.
`void`	`visit(UpperExpressionStateObject stateObject)` Visits the given `UpperExpressionStateObject`.
`void`	`visit(ValueExpressionStateObject stateObject)` Visits the given `ValueExpressionStateObject`.
`void`	`visit(WhenClauseStateObject stateObject)` Visits the given `WhenClauseStateObject`.
`void`	`visit(WhereClauseStateObject stateObject)` Visits the given `WhereClauseStateObject`.

Methods inherited from class org.eclipse.persistence.jpa.jpql.model.BaseJPQLQueryFormatter
`formatIdentifier, getIdentifierStyle, toString, toString, toText`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

exactMatch

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.

Constructor Detail