GrammarValidator (Oracle Fusion Middleware Java API Reference for Oracle TopLink)

This visitor is responsible to gather the problems and warnings found in the query by validating it with the JPQL grammar. The semantic is not validated by this visitor.

Since:: 2.3
Version:: 2.3
Author:: Pascal Filion
See Also:: SemanticValidator

Nested Class Summary
`private class`	`GrammarValidator.AbstractCollectionValidator` This validate is responsible to validate the collection of `Expressions`: Making sure they are all separated by a comma or by a space (depending on which one is required); Making sure it does not end with a comma; There is no empty expression between two commas.
`private class`	`GrammarValidator.AbstractDoubleEncapsulatedExpressionHelper<T extends AbstractDoubleEncapsulatedExpression>`
`private static interface`	`GrammarValidator.AbstractEncapsulatedExpressionHelper<T extends AbstractEncapsulatedExpression>` The root helper that validates any `AbstractEncapsulatedExpression`.
`private class`	`GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<T extends AbstractSingleEncapsulatedExpression>` The abstract implementation of `GrammarValidator.AbstractSingleEncapsulatedExpressionHelper` which implements some of the methods since the behavior is the same for all subclasses of `AbstractSingleEncapsulatedExpression`.
`private class`	`GrammarValidator.AbstractTripleEncapsulatedExpressionHelper<T extends AbstractTripleEncapsulatedExpression>`
`private class`	`GrammarValidator.CollectionSeparatedByCommaValidator` This validator validates a `CollectionExpression` by making sure each item is separated by a comma.
`private class`	`GrammarValidator.CollectionSeparatedBySpaceValidator` This validator validates a `CollectionExpression` by making sure each item is not separated by a comma.
`private static class`	`GrammarValidator.ComparisonExpressionVisitor`
`private static class`	`GrammarValidator.FuncExpressionFinder` This visitor is responsible to traverse the parents of the visited `Expression` and stops if a parent is `FuncExpression`.

Nested classes/interfaces inherited from class org.eclipse.persistence.jpa.internal.jpql.AbstractValidator
`AbstractValidator.BypassChildCollectionExpressionVisitor, AbstractValidator.BypassParentSubExpressionVisitor, AbstractValidator.ExpressionValidator, AbstractValidator.OwningClauseVisitor`

Field Summary
`private GrammarValidator.CollectionSeparatedByCommaValidator`	`collectionSeparatedByCommaValidator` This validator validates a `CollectionExpression` by making sure each item is separated by a comma.
`private GrammarValidator.CollectionSeparatedBySpaceValidator`	`collectionSeparatedBySpaceValidator` This validator validates a `CollectionExpression` by making sure each item is separated by a space.
`private GrammarValidator.ComparisonExpressionVisitor`	`comparisonExpressionVisitor` This visitor is responsible to retrieve the visited `Expression` if it is a `ComparisonExpression`.
`private GrammarValidator.FuncExpressionFinder`	`funcExpressionFinder` This visitor is responsible to traverse the parents of the visited `Expression` and stops if a parent is `FuncExpression`.
`private java.util.Map<java.lang.String,java.lang.Object>`	`helpers` The registered expression helper mapped by the unique JPQL identifier of the same expression to validate.
`private java.util.Collection<InputParameter>`	`inputParameters` The cached `InputParameters` that are present in the entire JPQL query.
`private static java.util.regex.Pattern`	`numericalLiteralPattern` The compiled regular expression that validates numeric literals using `REGULAR_EXPRESSION_NUMERIC_LITERAL`.
`private static java.lang.String`	`REGULAR_EXPRESSION_NUMERIC_LITERAL` The regular expression of a numeric literal.

Fields inherited from class org.eclipse.persistence.jpa.internal.jpql.AbstractVisitor
`queryContext`

Constructor Summary
`GrammarValidator(JPQLQueryContext context)` Creates a new `GrammarValidator`.

Method Summary

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<AbsExpression> absExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<AllOrAnyExpression> allOrAnyExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<AvgFunction> avgFunctionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<AbsExpression> buildAbsExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<AllOrAnyExpression> buildAllOrAnyExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<AvgFunction> buildAvgFunctionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<CoalesceExpression> buildCoalesceExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<ConcatExpression> buildConcatExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<CountFunction> buildCountFunctionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<EntryExpression> buildEntryExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<ExistsExpression> buildExistsExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<FuncExpression> buildFuncExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<IndexExpression> buildIndexExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<KeyExpression> buildKeyExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<LengthExpression> buildLengthExpressionHelper()

private GrammarValidator.AbstractTripleEncapsulatedExpressionHelper<LocateExpression> buildLocateExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<LowerExpression> buildLowerExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<MaxFunction> buildMaxFunctionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<MinFunction> buildMinFunctionHelper()

private GrammarValidator.AbstractDoubleEncapsulatedExpressionHelper<ModExpression> buildModExpressionHelper()

private GrammarValidator.AbstractDoubleEncapsulatedExpressionHelper<NullIfExpression> buildNullIfExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<ObjectExpression> buildObjectExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<SizeExpression> buildSizeExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<SqrtExpression> buildSqrtExpressionHelper()

private GrammarValidator.AbstractTripleEncapsulatedExpressionHelper<SubstringExpression> buildSubstringExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<SumFunction> buildSumFunctionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<TrimExpression> buildTrimExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<TypeExpression> buildTypeExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<UpperExpression> buildUpperExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<ValueExpression> buildValueExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<CoalesceExpression> coalesceExpressionHelper()

private GrammarValidator.CollectionSeparatedByCommaValidator collectionSeparatedByCommaValidator()

private GrammarValidator.CollectionSeparatedBySpaceValidator collectionSeparatedBySpaceValidator()

private GrammarValidator.ComparisonExpressionVisitor comparisonExpressionVisitor()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<ConcatExpression> concatExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<CountFunction> countFunctionHelper()

void dispose()
Disposes of the internal data.

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<EntryExpression> entryExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<ExistsExpression> existsExpressionHelper()

private GrammarValidator.FuncExpressionFinder funcExpressionFinder()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<FuncExpression> funcExpressionHelper()

private

<T> T

getHelper(java.lang.String identifier)

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<IndexExpression> indexExpressionHelper()

protected void initialize()
Initializes this class.

private boolean isChildOfComparisonExpession(AllOrAnyExpression expression)

private boolean isIdentificationVariableDeclaredBefore(java.lang.String variableName, int variableNameIndex, int joinIndex, java.util.List<DeclarationResolver.Declaration> declarations)

private boolean isInFuncExpressionInSelectClause(AbstractValidator.OwningClauseVisitor visitor, InputParameter expression)

private boolean isNumericLiteral(java.lang.String text)

private boolean isRightParenthesisMissing(AbstractTripleEncapsulatedExpression expression)

private boolean isValidJPA20Identifier()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<KeyExpression> keyExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<LengthExpression> lengthExpressionHelper()

private GrammarValidator.AbstractTripleEncapsulatedExpressionHelper<LocateExpression> locateExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<LowerExpression> lowerExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<MaxFunction> maxFunctionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<MinFunction> minFunctionHelper()

private GrammarValidator.AbstractDoubleEncapsulatedExpressionHelper<ModExpression> modExpressionHelper()

private GrammarValidator.AbstractDoubleEncapsulatedExpressionHelper<NullIfExpression> nullIfExpressionHelper()

private java.util.regex.Pattern numericalLiteralPattern()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<ObjectExpression> objectExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<SizeExpression> sizeExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<SqrtExpression> sqrtExpressionHelper()

private GrammarValidator.AbstractTripleEncapsulatedExpressionHelper<SubstringExpression> substringExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<SumFunction> sumFunctionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<TrimExpression> trimExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<TypeExpression> typeExpressionHelper()

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<UpperExpression> upperExpressionHelper()

private void validateAbstractConditionalClause(AbstractConditionalClause expression, java.lang.String missingConditionalExpressionMessageKey, java.lang.String invalidConditionalExpressionMessageKey)

private

<T extends AbstractDoubleEncapsulatedExpression>

void

validateAbstractDoubleEncapsulatedExpression(T expression, GrammarValidator.AbstractDoubleEncapsulatedExpressionHelper<T> helper)

private void validateAbstractFromClause(AbstractFromClause expression)

private

<T extends AbstractSingleEncapsulatedExpression>

void

validateAbstractSingleEncapsulatedExpression(T expression, GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<T> helper)

private

<T extends AbstractTripleEncapsulatedExpression>

void

validateAbstractTripleEncapsulatedExpression(T expression, GrammarValidator.AbstractTripleEncapsulatedExpressionHelper<T> helper)

private void validateArithmeticExpression(ArithmeticExpression expression)

private void validateCollectionSeparatedByComma(Expression expression, java.lang.String endsWithCommaProblemKey, java.lang.String missingCommaProblemKey)
Validates

private void validateCollectionSeparatedBySpace(Expression expression, java.lang.String endsWithCommaProblemKey, java.lang.String hasCommaProblemKey)
Validates

private void validateCompoundExpression(CompoundExpression expression, java.lang.String identifier, java.lang.String missingLeftExpression, java.lang.String invalidLeftExpression, java.lang.String missingRightExpression, java.lang.String invalidRightExpression, java.lang.String leftExpressionQueryBNF, java.lang.String rightExpressionQueryBNF)

private void validateIdentifier(Expression expression, java.lang.String variableName, int variableLength, java.lang.String reservedWordProblemKey, java.lang.String invalidJavaIdentifierProblemKey)
Validates the given variable name to make sure: It is not a JPQL reserved identifier; It is a valid Java identifier.

private void validateInputParameters(JPQLExpression expression)

private void validateLogicalExpression(LogicalExpression expression, java.lang.String leftExpressionQueryBNF, java.lang.String rightExpressionQueryBNF)

private void validatePathExpression(AbstractPathExpression expression)

private void validateSelectStatement(AbstractSelectStatement expression)

private GrammarValidator.AbstractSingleEncapsulatedExpressionHelper<ValueExpression> valueExpressionHelper()

void visit(AbsExpression expression)
Visits the AbsExpression expression.

void visit(AbstractSchemaName expression)
Visits the AbstractSchemaName expression.

void visit(AdditionExpression expression)
Visits the AdditionExpression expression.

void visit(AllOrAnyExpression expression)
Visits the AllOrAnyExpression expression.

void visit(AndExpression expression)
Visits the AndExpression expression.

void visit(ArithmeticFactor expression)
Visits the ArithmeticFactor expression.

void visit(AvgFunction expression)
Visits the AvgFunction expression.

void visit(BadExpression expression)
Visits the BadExpression expression.

void visit(BetweenExpression expression)
Visits the BetweenExpression expression.

void visit(CaseExpression expression)
Visits the CaseExpression expression.

void visit(CoalesceExpression expression)
Visits the CoalesceExpression expression.

void visit(CollectionExpression expression)
Visits the CollectionExpression expression.

void visit(CollectionMemberDeclaration expression)
Visits the CollectionMemberDeclaration expression.

void visit(CollectionMemberExpression expression)
Visits the CollectionMemberExpression expression.

void visit(CollectionValuedPathExpression expression)
Visits the CollectionValuedPathExpression expression.

void visit(ComparisonExpression expression)
Visits the ComparisonExpression expression.

void visit(ConcatExpression expression)
Visits the ConcatExpression expression.

void visit(ConstructorExpression expression)
Visits the ConstructorExpression expression.

void visit(CountFunction expression)
Visits the CountFunction expression.

void visit(DateTime expression)
Visits the DateTime expression.

void visit(DeleteClause expression)
Visits the DeleteClause expression.

void visit(DeleteStatement expression)
Visits the DeleteStatement expression.

void visit(DivisionExpression expression)
Visits the DivisionExpression expression.

void visit(EmptyCollectionComparisonExpression expression)
Visits the EmptyCollectionComparisonExpression expression.

void visit(EntityTypeLiteral expression)
Visits the EntityTypeLiteral expression.

void visit(EntryExpression expression)
Visits the EntryExpression expression.

void visit(ExistsExpression expression)
Visits the ExistsExpression expression.

void visit(FromClause expression)
Visits the FromClause expression.

void visit(FuncExpression expression)
Visits the FuncExpression expression.

void visit(GroupByClause expression)
Visits the GroupByClause expression.

void visit(HavingClause expression)
Visits the HavingClause expression.

void visit(IdentificationVariable expression)
Visits the IdentificationVariable expression.

void visit(IdentificationVariableDeclaration expression)
Visits the IdentificationVariableDeclaration expression.

void visit(IndexExpression expression)
Visits the IndexExpression expression.

void visit(InExpression expression)
Visits the InExpression expression.

void visit(InputParameter expression)
Visits the InputParameter expression.

void visit(Join expression)
Visits the Join expression.

void visit(JoinFetch expression)
Visits the FetchJoin expression.

void visit(JPQLExpression expression)
Visits the JPQLExpression expression.

void visit(KeyExpression expression)
Visits the KeyExpression expression.

void visit(KeywordExpression expression)
Visits the KeywordExpression expression.

void visit(LengthExpression expression)
Visits the LengthExpression expression.

void visit(LikeExpression expression)
Visits the LikeExpression expression.

void visit(LocateExpression expression)
Visits the LocateExpression expression.

void visit(LowerExpression expression)
Visits the LowerExpression expression.

void visit(MaxFunction expression)
Visits the MaxFunction expression.

void visit(MinFunction expression)
Visits the MinFunction expression.

void visit(ModExpression expression)
Visits the ModExpression expression.

void visit(MultiplicationExpression expression)
Visits the MultiplicationExpression expression.

void visit(NotExpression expression)
Visits the NotExpression expression.

void visit(NullComparisonExpression expression)
Visits the NullComparisonExpression expression.

void visit(NullExpression expression)
Visits the NullExpression expression.

void visit(NullIfExpression expression)
Visits the NullIfExpression expression.

void visit(NumericLiteral expression)
Visits the NumericLiteral expression.

void visit(ObjectExpression expression)
Visits the ObjectExpression expression.

void visit(OrderByClause expression)
Visits the OrderByClause expression.

void visit(OrderByItem expression)
Visits the OrderByItem expression.

void visit(OrExpression expression)
Visits the OrExpression expression.

void visit(RangeVariableDeclaration expression)
Visits the RangeVariableDeclaration expression.

void visit(ResultVariable expression)
Visits the ResultVariable expression.

void visit(SelectClause expression)
Visits the SelectClause expression.

void visit(SelectStatement expression)
Visits the SelectStatement expression.

void visit(SimpleFromClause expression)
Visits the SimpleFromClause expression.

void visit(SimpleSelectClause expression)
Visits the SimpleSelectClause expression.

void visit(SimpleSelectStatement expression)
Visits the SimpleSelectStatement expression.

void visit(SizeExpression expression)
Visits the SizeExpression expression.

void visit(SqrtExpression expression)
Visits the SqrtExpression expression.

void visit(StateFieldPathExpression expression)
Visits the StateFieldPathExpression expression.

void visit(StringLiteral expression)
Visits the StringLiteral expression.

void visit(SubExpression expression)
Visits the SubExpression expression.

void visit(SubstringExpression expression)
Visits the SubstringExpression expression.

void visit(SubtractionExpression expression)
Visits the SubtractionExpression expression.

void visit(SumFunction expression)
Visits the SumFunction expression.

void visit(TreatExpression expression)
Visits the TreatExpression expression.

void visit(TrimExpression expression)
Visits the TrimExpression expression.

void visit(TypeExpression expression)
Visits the TypeExpression expression.

void visit(UnknownExpression expression)
Visits the UnknownExpression expression.

void visit(UpdateClause expression)
Visits the UpdateClause expression.

void visit(UpdateItem expression)
Visits the UpdateItem expression.

void visit(UpdateStatement expression)
Visits the UpdateStatement expression.

void visit(UpperExpression expression)
Visits the UpperExpression expression.

void visit(ValueExpression expression)
Visits the ValueExpression expression.

void visit(WhenClause expression)
Visits the WhenClause expression.

void visit(WhereClause expression)
Visits the WhereClause expression.

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.AbstractValidator
`addProblem, addProblem, addProblem, buildExpressionValidator, bypassChildCollectionExpressionVisitor, bypassParentSubExpressionVisitor, children, expressionValidator, internalOrderByItemBNFValidator, isOwnedByConditionalClause, isOwnedByFromClause, isOwnedBySubFromClause, isValid, isValidJavaIdentifier, isValidWithChildCollectionBypass, isValidWithFindQueryBNF, isValidWithParentSubExpressionBypass, length, owningClauseVisitor, position, setProblems, visit`

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.AbstractValidator

addProblem, addProblem, addProblem, buildExpressionValidator, bypassChildCollectionExpressionVisitor, bypassParentSubExpressionVisitor, children, expressionValidator, internalOrderByItemBNFValidator, isOwnedByConditionalClause, isOwnedByFromClause, isOwnedBySubFromClause, isValid, isValidJavaIdentifier, isValidWithChildCollectionBypass, isValidWithFindQueryBNF, isValidWithParentSubExpressionBypass, length, owningClauseVisitor, position, setProblems, visit

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.AbstractVisitor
`collectionExpression, embeddable, entity, getJPAVersion, getManagedType, getManagedType, getMapping, getProvider, getQuery, getQueryExpression, getResolver, getType, getType, getType, getTypeDeclaration, getTypeHelper, getTypeRepository, isEclipseLinkPlatform, isEmbeddable, isEntity, isJavaPlatform, isMappedSuperclass, isNull, mappedSuperclass`

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

Field Detail

collectionSeparatedByCommaValidator

private GrammarValidator.CollectionSeparatedByCommaValidator collectionSeparatedByCommaValidator

This validator validates a CollectionExpression by making sure each item is separated by a comma.

collectionSeparatedBySpaceValidator

private GrammarValidator.CollectionSeparatedBySpaceValidator collectionSeparatedBySpaceValidator

This validator validates a CollectionExpression by making sure each item is separated by a space.

comparisonExpressionVisitor

private GrammarValidator.ComparisonExpressionVisitor comparisonExpressionVisitor

This visitor is responsible to retrieve the visited Expression if it is a ComparisonExpression.

funcExpressionFinder

private GrammarValidator.FuncExpressionFinder funcExpressionFinder

This visitor is responsible to traverse the parents of the visited Expression and stops if a parent is FuncExpression.

helpers

private java.util.Map<java.lang.String,java.lang.Object> helpers

The registered expression helper mapped by the unique JPQL identifier of the same expression to validate.

inputParameters

private java.util.Collection<InputParameter> inputParameters

The cached InputParameters that are present in the entire JPQL query.

numericalLiteralPattern

private static java.util.regex.Pattern numericalLiteralPattern

The compiled regular expression that validates numeric literals using REGULAR_EXPRESSION_NUMERIC_LITERAL.

REGULAR_EXPRESSION_NUMERIC_LITERAL

private static final java.lang.String REGULAR_EXPRESSION_NUMERIC_LITERAL

The regular expression of a numeric literal. The possible forms are:

  2, +2, -2, 2.2, +2.2, -2.2
  2E10, +2E10, 2E+10, +2E+10
 -2E10, 2E-10, -2E-10
  2.2E10, +2.2E10, 2.2E+10, +2.2+E10
 -2E10, 2E-10, -2E-10
 -2.2E10, 2.2-E10, -2.2E-10
  2d,    2D,    2f,    2F
 +2d,   +2D,   +2f,   +2F
 -2d,   -2D,   -2f,   -2F
  2.2d,  2.2D,  2.2f,  2.2F
 -2.2d, -2.2D, -2.2f, -2.2F
 +2.2d, +2.2D, +2.2f, +2.2F

See Also:: Constant Field Values

Constructor Detail