Class IdentificationVariableDeclaration

  • All Implemented Interfaces:

    public final class IdentificationVariableDeclaration
    extends AbstractExpression
    An identification variable is a valid identifier declared in the FROM clause of a query. All identification variables must be declared in the FROM clause. Identification variables cannot be declared in other clauses. An identification variable must not be a reserved identifier or have the same name as any entity in the same persistence unit: Identification variables are case insensitive. An identification variable evaluates to a value of the type of the expression used in declaring the variable.
    BNF: identification_variable_declaration ::= range_variable_declaration { join | fetch_join }*

    Pascal Filion
    • Constructor Detail

      • IdentificationVariableDeclaration

        public IdentificationVariableDeclaration​(AbstractExpression parent)
        Creates a new IdentificationVariableDeclaration.
        parent - The parent of this expression
    • Method Detail

      • buildCollectionExpression

        public CollectionExpression buildCollectionExpression()
        Creates a new CollectionExpression that will wrap the single join expression.
        The single join expression represented by a temporary collection
      • getJoins

        public Expression getJoins()
        Returns the unique join (fetch join) or the list of joins (fetch joins) expression.
        The JOIN expression(s) or a null expression if none was declared
      • getRangeVariableDeclaration

        public Expression getRangeVariableDeclaration()
        Returns the variable declaration, which is the abstract schema name and the identification variable.
        The Expression representing the range variable declaration
      • hasJoins

        public boolean hasJoins()
        Determines whether this declaration has any join expressions.
        true if at least one join expression was specified; false otherwise
      • hasRangeVariableDeclaration

        public boolean hasRangeVariableDeclaration()
        Determines whether the range variable declaration was parsed.
        true if the range variable declaration was parsed; false otherwise
      • hasSpace

        public boolean hasSpace()
        Determines whether there is a space after the range variable declaration.
        true if the range variable declaration is followed by a space, false otherwise
      • isParsingComplete

        protected boolean isParsingComplete​(WordParser wordParser,
                                            java.lang.String word,
                                            Expression expression)
        Determines whether the parsing is complete based on what is left in the given text. The text is never empty.
        isParsingComplete in class AbstractExpression
        wordParser - The text to parse based on the current position of the cursor
        word - The word that was retrieved from the given text, which is the first word in the text
        expression - The Expression that has already been parsed
        true if the text no longer can't be parsed by the current expression; false if more can be parsed
      • parse

        protected void parse​(WordParser wordParser,
                             boolean tolerant)
        Parses the query by starting at the current position, which is part of the given WordParser.
        Specified by:
        parse in class AbstractExpression
        wordParser - The text to parse based on the current position of the cursor
        tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
      • shouldParseWithFactoryFirst

        protected boolean shouldParseWithFactoryFirst()
        Determines whether the parsing of the query should be performed using the factories first or it should automatically fallback to the fallback factory.
        shouldParseWithFactoryFirst in class AbstractExpression
        true is returned by default so the factories are used before falling back
      • toParsedText

        protected void toParsedText​(java.lang.StringBuilder writer,
                                    boolean actual)
        Generates a string representation of this Expression, including its children, if it has any.
        Specified by:
        toParsedText in class AbstractExpression
        writer - The buffer used to append this Expression's string representation
        actual - Determines whether the string representation should represent what was parsed, i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the JPQL identifiers