Package org.eclipse.persistence.jpa.jpql

Class 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:
    AbstractGrammarValidator, AbstractSemanticValidator
    Author:
    Pascal Filion
    Since:
    2.4

    • Constructor Detail

      • AbstractValidator

        protected AbstractValidator()
        Creates a new AbstractValidator.

    • Method Detail

      • addProblem

        protected void addProblem​(Expression expression,
                          int startPosition,
                          int endPosition,
                          java.lang.String messageKey,
                          java.lang.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,
                          java.lang.String messageKey,
                          java.lang.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,
                          java.lang.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,
                          java.lang.String messageKey,
                          java.lang.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

      • buildLiteralVisitor

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

      • buildProblem

        protected JPQLQueryProblem buildProblem​(Expression expression,
                                        int startPosition,
                                        int endPosition,
                                        java.lang.String messageKey,
                                        java.lang.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

      • dispose

        public void dispose()
        Disposes this visitor.

      • 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

      • 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

      • getLiteralVisitor

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

      • getProvider

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

      • getProviderVersion

        protected java.lang.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
        Since:
        2.4

      • getQueryBNF

        protected JPQLQueryBNF getQueryBNF​(java.lang.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

      • initialize

        protected void initialize()
        Initializes this validator.

      • 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
        Since:
        2.5

      • isValidWithChildCollectionBypass

        protected boolean isValidWithChildCollectionBypass​(Expression expression,
                                                   java.lang.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
        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
        Since:
        2.4

      • 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
        Since:
        2.4

      • 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 java.lang.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.
        Returns:
        The number of items in the array or -1 if the Expression is not a nested array
        Since:
        2.5

      • 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
        Since:
        2.4

      • setProblems

        public void setProblems​(java.util.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:
        java.lang.NullPointerException - The Collection cannot be null