Package org.eclipse.persistence.jpa.jpql

Class AbstractValidator

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
org.eclipse.persistence.jpa.jpql.AbstractValidator
All Implemented Interfaces:
ExpressionVisitor
Direct Known Subclasses:
AbstractGrammarValidator, AbstractSemanticValidator
public abstract class AbstractValidator extends AnonymousExpressionVisitor
The abstract definition of a validator, which provides helper methods and visitors.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Version:
2.5
See Also:
Author:
Pascal Filion

  • Constructor Details

    • AbstractValidator

      protected AbstractValidator()
      Creates a new AbstractValidator.

  • Method Details

    • addProblem

      protected void addProblem(Expression expression, int startPosition, int endPosition, String messageKey, String... messageArguments)
      Adds a new validation problem that was found in the given Expression.
      Parameters:
      expression - The Expression that is either not following the BNF grammar or that has semantic problems
      startPosition - The position where the problem was encountered
      endPosition - The position where the problem ends, inclusively
      messageKey - The key used to retrieve the localized message describing the problem
      messageArguments - The list of arguments that can be used to format the localized description of the problem

    • addProblem

      protected void addProblem(Expression expression, int startPosition, String messageKey, String... messageArguments)
      Adds a new validation problem that was found in the given Expression.
      Parameters:
      expression - The Expression that is either not following the BNF grammar or that has semantic problems
      startPosition - The position where the problem was encountered
      messageKey - The key used to retrieve the localized message describing the problem
      messageArguments - The list of arguments that can be used to format the localized description of the problem

    • addProblem

      protected void addProblem(Expression expression, String messageKey)
      Adds a new validation problem that was found in the given Expression. The start index is the position of the given Expression within the JPQL query and the end index is the end position of the Expression within the JPQL query.
      Parameters:
      expression - The Expression that is either not following the BNF grammar or that has semantic problems
      messageKey - The key used to retrieve the localized message describing the problem

    • addProblem

      protected void addProblem(Expression expression, String messageKey, String... arguments)
      Adds a new validation problem that was found in the given Expression. The start index is the position of the given Expression within the JPQL query and the end index is the end position of the Expression within the JPQL query.
      Parameters:
      expression - The Expression that is either not following the BNF grammar or that has semantic problems
      messageKey - The key used to retrieve the localized message describing the problem
      arguments - The list of arguments that can be used to format the localized description of the problem

    • buildChildrenCollector

      protected AbstractValidator.ChildrenCollectorVisitor buildChildrenCollector()

    • buildLiteralVisitor

      protected abstract LiteralVisitor buildLiteralVisitor()
      Creates the visitor that can retrieve some information about various literal.
      Returns:
      A new LiteralVisitor

    • buildNestedArrayVisitor

      protected AbstractValidator.NestedArrayVisitor buildNestedArrayVisitor()
      Creates the visitor that traverses an Expression and determines if it's a nested array or not.
      Returns:
      A new AbstractValidator.NestedArrayVisitor

    • buildOwningClauseVisitor

      protected abstract AbstractValidator.OwningClauseVisitor buildOwningClauseVisitor()
      Creates the visitor that traverses the parent hierarchy of any Expression and stops at the first Expression that is a clause.
      Returns:
      A new AbstractValidator.OwningClauseVisitor

    • buildOwningStatementVisitor

      protected AbstractValidator.OwningStatementVisitor buildOwningStatementVisitor()
      Creates the visitor that traverses the parent hierarchy of any Expression and stops at the first Expression that is a statement.
      Returns:
      A new AbstractValidator.OwningStatementVisitor

    • buildProblem

      protected JPQLQueryProblem buildProblem(Expression expression, int startPosition, int endPosition, String messageKey, String... messageArguments)
      Creates a new validation problem that was found in the given Expression.
      Parameters:
      expression - The Expression that is either not following the BNF grammar or that has semantic problems
      startPosition - The position where the problem was encountered
      endPosition - The position where the problem ends, inclusively
      messageKey - The key used to retrieve the localized message describing the problem
      messageArguments - The list of arguments that can be used to format the localized description of the problem
      Returns:
      The JPQLQueryProblem describing a problem

    • buildSubqueryVisitor

      protected AbstractValidator.SubqueryVisitor buildSubqueryVisitor()
      Creates the visitor that checks if the visited expression is a subquery or not..
      Returns:
      A new AbstractValidator.SubqueryVisitor

    • dispose

      public void dispose()
      Disposes this visitor.

    • getBypassChildCollectionExpressionVisitor

      protected AbstractValidator.BypassChildCollectionExpressionVisitor getBypassChildCollectionExpressionVisitor()

    • getBypassParentSubExpressionVisitor

      protected AbstractValidator.BypassParentSubExpressionVisitor getBypassParentSubExpressionVisitor()

    • getChildren

      protected List<Expression> getChildren(Expression expression)
      Returns a list containing either the given Expression if it's not a CollectionExpression or the children of the given CollectionExpression.
      Parameters:
      expression - The Expression to visit
      Returns:
      A list containing either the given Expression or the children of CollectionExpression

    • getChildrenCollectorVisitor

      protected AbstractValidator.ChildrenCollectorVisitor getChildrenCollectorVisitor()

    • getExpressionRegistry

      protected ExpressionRegistry getExpressionRegistry()
      Returns the registry containing the JPQLQueryBNFs and the ExpressionFactories that are used to properly parse a JPQL query.
      Returns:
      The registry containing the information related to the JPQL grammar

    • getExpressionValidator

      protected AbstractValidator.JPQLQueryBNFValidator getExpressionValidator(String queryBNF)

    • getGrammar

      protected abstract JPQLGrammar getGrammar()
      Returns the JPQLGrammar that defines how the JPQL query was parsed.
      Returns:
      The JPQLGrammar that was used to parse the JPQL query

    • getJPAVersion

      protected JPAVersion getJPAVersion()
      Returns the version of the Java Persistence this entity for which it was defined.
      Returns:
      The version of the Java Persistence being used

    • getJPQLQueryBNFValidator

      protected AbstractValidator.JPQLQueryBNFValidator getJPQLQueryBNFValidator(JPQLQueryBNF queryBNF)
      Returns the AbstractValidator.JPQLQueryBNFValidator that can be used to validate an Expression by making sure its BNF is part of the given BNF.
      Parameters:
      queryBNF - The BNF used to determine the validity of an Expression
      Returns:
      A AbstractValidator.JPQLQueryBNFValidator that can determine if an Expression follows the given BNF

    • getJPQLQueryBNFValidator

      protected AbstractValidator.JPQLQueryBNFValidator getJPQLQueryBNFValidator(String queryBNF)
      Returns the AbstractValidator.JPQLQueryBNFValidator that can be used to validate an Expression by making sure its BNF is part of the given BNF.
      Parameters:
      queryBNF - The BNF used to determine the validity of an Expression
      Returns:
      A AbstractValidator.JPQLQueryBNFValidator that can determine if an Expression follows the given BNF

    • getLiteralVisitor

      protected LiteralVisitor getLiteralVisitor()
      Returns the visitor that can retrieve some information about various literal.
      Returns:
      A LiteralVisitor

    • getNestedArrayVisitor

      protected AbstractValidator.NestedArrayVisitor getNestedArrayVisitor()
      Returns the visitor that can determine if an Expression represents a nested array.
      Returns:
      A AbstractValidator.NestedArrayVisitor

    • getOwningClauseVisitor

      protected AbstractValidator.OwningClauseVisitor getOwningClauseVisitor()
      Returns the visitor that traverses the parent hierarchy of any Expression and stops at the first Expression that is a clause.
      Returns:
      AbstractValidator.OwningClauseVisitor

    • getOwningStatementVisitor

      protected AbstractValidator.OwningStatementVisitor getOwningStatementVisitor()
      Returns the visitor that traverses the parent hierarchy of any Expression and stops at the first Expression that is a statement.
      Returns:
      AbstractValidator.OwningStatementVisitor

    • getProvider

      protected String getProvider()
      Returns the persistence provider name.
      Returns:
      The name of the persistence provider, null should never be returned

    • getProviderVersion

      protected String getProviderVersion()
      Returns the version of the persistence provider.
      Returns:
      The version of the persistence provider, if one is extending the default JPQL grammar defined in the Java Persistence specification, otherwise returns an empty string

    • getQueryBNF

      protected JPQLQueryBNF getQueryBNF(String queryBNFId)
      Retrieves the BNF object that was registered for the given unique identifier.
      Parameters:
      queryBNFId - The unique identifier of the JPQLQueryBNF to retrieve
      Returns:
      The JPQLQueryBNF representing a section of the grammar

    • getSubqueryVisitor

      protected AbstractValidator.SubqueryVisitor getSubqueryVisitor()
      Returns the visitor that checks if the visited expression is a subquery or not.
      Returns:
      AbstractValidator.SubqueryVisitor

    • initialize

      protected void initialize()
      Initializes this validator.

    • isNestedArray

      protected boolean isNestedArray(Expression expression)
      Determines whether the given Expression represents a nested array or not. To be a nested array, the given Expression is a SubExpression and its child is a CollectionExpression.
      Parameters:
      expression - The Expression to check its size
      Returns:
      true if the given Expression is a nested array; false otherwise

    • isSubquery

      protected boolean isSubquery(Expression expression)
      Determines whether the given Expression is a subquery.
      Parameters:
      expression - The Expression to check its type
      Returns:
      true if the given Expression is a subquery; false otherwise

    • isValid

      protected boolean isValid(Expression expression, JPQLQueryBNF queryBNF)
      Determines whether the given Expression is valid by checking its JPQLQueryBNF with the given JPQLQueryBNF.
      Parameters:
      expression - The Expression to validate based on the query BNF
      queryBNF - The JPQLQueryBNF that determines if the given Expression is valid
      Returns:
      true if the Expression's JPQLQueryBNF is either the JPQLQueryBNF or a child of it; false otherwise

    • isValid

      protected boolean isValid(Expression expression, String queryBNFId)
      Determines whether the given Expression is valid by checking its JPQLQueryBNF with the JPQLQueryBNF associated with the given unique identifier.
      Parameters:
      expression - The Expression to validate based on the query BNF
      queryBNFId - The unique identifier of the JPQLQueryBNF that determines if the given Expression is valid
      Returns:
      true if the Expression's JPQLQueryBNF is either the JPQLQueryBNF or a child of it; false otherwise

    • isValid

      protected boolean isValid(Expression expression, String... queryBNFIds)
      Determines whether the given Expression is valid by checking its JPQLQueryBNF with the list of JPQLQueryBNF associated with the given unique identifiers.
      Parameters:
      expression - The Expression to validate based on the query BNF
      queryBNFIds - The unique identifier of the JPQLQueryBNF that determines if the given Expression is valid
      Returns:
      true if the Expression's JPQLQueryBNF is either the JPQLQueryBNF or a child of it; false otherwise

    • isValidWithChildCollectionBypass

      protected boolean isValidWithChildCollectionBypass(Expression expression, String queryBNF)
      Determines whether the given Expression part is an expression of the given query BNF. The CollectionExpression that may be the direct child of the given Expression will be bypassed.
      Parameters:
      expression - The Expression to validate based on the query BNF
      queryBNF - The unique identifier of the JPQLQueryBNF that looks up the AbstractValidator.JPQLQueryBNFValidator
      Returns:
      true if the Expression part is a child of the given query BNF; false otherwise

    • isWithinSubquery

      protected boolean isWithinSubquery(Expression expression)
      Determines whether the given Expression is part of a subquery.
      Parameters:
      expression - The Expression to start scanning its location
      Returns:
      true if the given Expression is part of a subquery; false if it's part of the top-level query

    • isWithinTopLevelQuery

      protected boolean isWithinTopLevelQuery(Expression expression)
      Determines whether the given Expression is part of the top-level query.
      Parameters:
      expression - The Expression to start scanning its location
      Returns:
      true if the given Expression is part of the top-level query; false if it's part of a subquery

    • length

      protected int length(Expression expression)
      Returns the length of the string representation of the given Expression.
      Parameters:
      expression - The Expression to retrieve the length of its string
      Returns:
      The length of the string representation of the given Expression

    • literal

      protected String literal(Expression expression, LiteralType type)
      Retrieves the "literal" from the given Expression. The literal to retrieve depends on the given type. The literal is basically a string value like an identification variable name, an input parameter, a path expression, an abstract schema name, etc.
      Parameters:
      expression - The Expression to visit
      type - The LiteralType helps to determine what to retrieve from the visited Expression
      Returns:
      A value from the given Expression or an empty string if the given Expression and the LiteralType do not match

    • nestedArraySize

      protected int nestedArraySize(Expression expression)
      Returns the number of items in the nested array if the given Expression represents one. To be a nested array, the given Expression is a SubExpression and its child is a CollectionExpression.
      Parameters:
      expression - The Expression to visit
      Returns:
      The number of items in the array or -1 if the Expression is not a nested array

    • position

      protected int position(Expression expression)
      Calculates the position of the given expression by calculating the length of what is before.
      Parameters:
      expression - The expression to determine its position within the parsed tree
      Returns:
      The length of the string representation of what comes before the given expression

    • problemsSize

      public final int problemsSize()
      Returns the current number of problems that were registered during validation.
      Returns:
      The current number of problems

    • setProblems

      public void setProblems(Collection<JPQLQueryProblem> problems)
      Sets the collection that will be used to store problems this validator will find in the JPQL query.
      Parameters:
      problems - A non-null collection that will be used to store the problems if any was found
      Throws:
      NullPointerException - The Collection cannot be null

    • visit

      protected void visit(Expression expression)
      Description copied from class: AnonymousExpressionVisitor
      Blindly visit the given Expression.
      Overrides:
      visit in class AnonymousExpressionVisitor
      Parameters:
      expression - The Expression to visit