Package org.eclipse.persistence.jpa.jpql.parser

Class DateTime

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.DateTime
All Implemented Interfaces:
Expression
public final class DateTime extends AbstractExpression
This Expression represents a date or time. It supports the following identifiers:

CURRENT_DATE: This function returns the value of current date on the database server.

CURRENT_TIME: This function returns the value of current time on the database server.

CURRENT_TIMESTAMP: This function returns the value of current timestamp on the database server.

BNF: functions_returning_datetime ::= CURRENT_DATE | CURRENT_TIME | CURRENT_TIMESTAMP

The JDBC escape syntax may be used for the specification of date, time, and timestamp literals.

BNF: expression ::= {d 'yyyy-mm-dd'} | {t 'hh:mm:ss'} | {ts 'yyyy-mm-dd hh:mm:ss.f...'}

Version:
2.4
Author:
Pascal Filion

  • Constructor Details

    • DateTime

      public DateTime(AbstractExpression parent)
      Creates a new DateTime.
      Parameters:
      parent - The parent of this expression

  • Method Details

    • accept

      public void accept(ExpressionVisitor visitor)
      Description copied from interface: Expression
      Visits this Expression by the given visitor.
      Parameters:
      visitor - The ExpressionVisitor to visit this object

    • acceptChildren

      public void acceptChildren(ExpressionVisitor visitor)
      Description copied from interface: Expression
      Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time Expression.children() is called.

      This does not traverse the Expression sub-hierarchy, use a subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

      Parameters:
      visitor - The visitor to visit the children of this object.

    • addOrderedChildrenTo

      protected void addOrderedChildrenTo(List<Expression> children)
      Description copied from class: AbstractExpression
      Adds the children of this AbstractExpression to the given list.
      Overrides:
      addOrderedChildrenTo in class AbstractExpression
      Parameters:
      children - The list used to store the string representation of this AbstractExpression

    • getActualIdentifier

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

    • getQueryBNF

      public JPQLQueryBNF getQueryBNF()
      Description copied from interface: Expression
      Returns the BNF of this Expression.
      Returns:
      The JPQLQueryBNF, which represents the grammar of this Expression

    • getText

      public String getText()
      Description copied from class: AbstractExpression
      Returns the encapsulated text of this AbstractExpression, which can be used in various ways, it can be a keyword, a literal, etc.
      Overrides:
      getText in class AbstractExpression
      Returns:
      Either the JPQL identifier for this AbstractExpression, the literal it encapsulates or an empty string

    • isCurrentDate

      public boolean isCurrentDate()
      Determines whether this DateTime represents the JPQL identifier CURRENT_DATE.
      Returns:
      true if this Expression represents CURRENT_DATE; false otherwise

    • isCurrentTime

      public boolean isCurrentTime()
      Determines whether this DateTime represents the JPQL identifier CURRENT_TIME.
      Returns:
      true if this Expression represents CURRENT_TIME; false otherwise

    • isCurrentTimestamp

      public boolean isCurrentTimestamp()
      Determines whether this DateTime represents the JPQL identifier CURRENT_TIMESTAMP.
      Returns:
      true if this Expression represents CURRENT_TIMESTAMP; false otherwise

    • isJDBCDate

      public boolean isJDBCDate()
      Determines whether this DateTime represents the JDBC escape syntax for date, time, timestamp formats.
      Returns:
      true if this Expression represents a JDBC escape syntax; false otherwise

    • parse

      protected void parse(WordParser wordParser, boolean tolerant)
      Description copied from class: AbstractExpression
      Parses the query by starting at the current position, which is part of the given WordParser.
      Specified by:
      parse in class AbstractExpression
      Parameters:
      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

    • toActualText

      public String toActualText()
      Description copied from interface: Expression
      Generates a string representation of this Expression, which needs to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist.
      Specified by:
      toActualText in interface Expression
      Overrides:
      toActualText in class AbstractExpression
      Returns:
      The string representation of this Expression

    • toParsedText

      public String toParsedText()
      Description copied from interface: Expression
      Returns a string representation of this Expression and its children. The expression should contain whitespace even if the beautified version would not have any. For instance, "SELECT e " should be returned where Expression.toParsedText() would return "SELECT e".
      Specified by:
      toParsedText in interface Expression
      Overrides:
      toParsedText in class AbstractExpression
      Returns:
      The string representation of this Expression

    • toParsedText

      protected void toParsedText(StringBuilder writer, boolean actual)
      Description copied from class: AbstractExpression
      Generates a string representation of this Expression, including its children, if it has any.
      Specified by:
      toParsedText in class AbstractExpression
      Parameters:
      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