Class AbstractFromClause

  • All Implemented Interfaces:
    Expression
    Direct Known Subclasses:
    FromClause, SimpleFromClause

    public abstract class AbstractFromClause
    extends AbstractExpression
    The FROM clause of a query defines the domain of the query by declaring identification variables. An identification variable is an identifier declared in the FROM clause of a query. The domain of the query may be constrained by path expressions. Identification variables designate instances of a particular entity abstract schema type. The FROM clause can contain multiple identification variable declarations separated by a comma (,).
    Since:
    2.3
    Version:
    2.5
    Author:
    Pascal Filion
    See Also:
    FromClause, SimpleFromClause
    • Method Detail

      • buildCollectionExpression

        public final CollectionExpression buildCollectionExpression()
        Creates a new CollectionExpression that will wrap the single declaration.
        Returns:
        The single declaration represented by a temporary collection
      • getActualIdentifier

        public final String getActualIdentifier()
        Returns the actual FROM identifier found in the string representation of the JPQL query, which has the actual case that was used.
        Returns:
        The FROM identifier that was actually parsed
      • getAsOfClause

        public final Expression getAsOfClause()
        Returns the Expression representing the AS OF clause.
        Returns:
        The expression representing the AS OF clause
      • getDeclaration

        public final Expression getDeclaration()
        Returns the Expression that represents the declaration of this clause.
        Returns:
        The expression that was parsed representing the declaration
      • getDeclarationQueryBNFId

        public abstract String getDeclarationQueryBNFId()
        Returns the BNF of the declaration part of this clause.
        Returns:
        The BNF of the declaration part of this clause
      • getHierarchicalQueryClause

        public final Expression getHierarchicalQueryClause()
        Returns the Expression representing the hierarchical query clause.
        Returns:
        The expression representing the hierarchical query clause
        Since:
        2.5
      • hasAsOfClause

        public final boolean hasAsOfClause()
        Determines whether the AS OF clause is defined.
        Returns:
        true if the query that got parsed had the AS OF clause
      • hasDeclaration

        public final boolean hasDeclaration()
        Determines whether the declaration of this clause was parsed.
        Returns:
        true if the declaration of this clause was parsed; false if it was not parsed
      • hasHierarchicalQueryClause

        public final boolean hasHierarchicalQueryClause()
        Determines whether the hierarchical query clause was parsed or not.
        Returns:
        true if the query that got parsed had the hierarchical query clause
        Since:
        2.5
      • hasSpaceAfterDeclaration

        public final boolean hasSpaceAfterDeclaration()
        Determines whether a whitespace was found after the declaration query clause, which will be true if it's followed by either the hierarchical query clause or the AS OF clause.
        Returns:
        true if there was a whitespace after the declaration; false otherwise
        Since:
        2.5
      • hasSpaceAfterFrom

        public final boolean hasSpaceAfterFrom()
        Determines whether a whitespace was parsed after the FROM identifier.
        Returns:
        true if a whitespace was parsed after the FROM identifier; false otherwise
      • hasSpaceAfterHierarchicalQueryClause

        public final boolean hasSpaceAfterHierarchicalQueryClause()
        Determines whether a whitespace was found after the hierarchical query clause. In some cases, the space is owned by a child of the hierarchical query clause.
        Returns:
        true if there was a whitespace after the hierarchical query clause and owned by this expression; false otherwise
        Since:
        2.5