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
ThisExpression
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...'}
- Since:
- 2.3
- Version:
- 2.4
- Author:
- Pascal Filion
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE
-
Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression
ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
-
-
Constructor Summary
Constructors Constructor Description DateTime(AbstractExpression parent)
Creates a newDateTime
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(ExpressionVisitor visitor)
Visits thisExpression
by the givenvisitor
.void
acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
.java.lang.String
getActualIdentifier()
Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used.JPQLQueryBNF
getQueryBNF()
Returns the BNF of thisExpression
.java.lang.String
getText()
boolean
isCurrentDate()
Determines whether thisDateTime
represents the JPQL identifierCURRENT_DATE
.boolean
isCurrentTime()
Determines whether thisDateTime
represents the JPQL identifierCURRENT_TIME
.boolean
isCurrentTimestamp()
Determines whether thisDateTime
represents the JPQL identifierCURRENT_TIMESTAMP
.boolean
isJDBCDate()
Determines whether thisDateTime
represents the JDBC escape syntax for date, time, timestamp formats.java.lang.String
toActualText()
Generates a string representation of thisExpression
, which needs to include any characters that are considered virtual, i.e.java.lang.String
toParsedText()
Returns a string representation of thisExpression
and its children.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
children, findQueryBNF, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toString
-
-
-
-
Constructor Detail
-
DateTime
public DateTime(AbstractExpression parent)
Creates a newDateTime
.- Parameters:
parent
- The parent of this expression
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpression
by the givenvisitor
.- Parameters:
visitor
- TheExpressionVisitor
to visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()
is called.This does not traverse the
Expression
sub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.- Parameters:
visitor
- Thevisitor
to visit the children of this object.
-
getActualIdentifier
public java.lang.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()
Returns the BNF of thisExpression
.- Returns:
- The
JPQLQueryBNF
, which represents the grammar of thisExpression
-
getText
public java.lang.String getText()
-
isCurrentDate
public boolean isCurrentDate()
Determines whether thisDateTime
represents the JPQL identifierCURRENT_DATE
.- Returns:
true
if thisExpression
representsCURRENT_DATE
;false
otherwise
-
isCurrentTime
public boolean isCurrentTime()
Determines whether thisDateTime
represents the JPQL identifierCURRENT_TIME
.- Returns:
true
if thisExpression
representsCURRENT_TIME
;false
otherwise
-
isCurrentTimestamp
public boolean isCurrentTimestamp()
Determines whether thisDateTime
represents the JPQL identifierCURRENT_TIMESTAMP
.- Returns:
true
if thisExpression
representsCURRENT_TIMESTAMP
;false
otherwise
-
isJDBCDate
public boolean isJDBCDate()
Determines whether thisDateTime
represents the JDBC escape syntax for date, time, timestamp formats.- Returns:
true
if thisExpression
represents a JDBC escape syntax;false
otherwise
-
toActualText
public java.lang.String toActualText()
Generates a string representation of thisExpression
, 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 interfaceExpression
- Overrides:
toActualText
in classAbstractExpression
- Returns:
- The string representation of this
Expression
-
toParsedText
public java.lang.String toParsedText()
Returns a string representation of thisExpression
and its children. The expression should contain whitespace even if the beautified version would not have any. For instance, "SELECT e " should be returned whereExpression.toParsedText()
would return "SELECT e".- Specified by:
toParsedText
in interfaceExpression
- Overrides:
toParsedText
in classAbstractExpression
- Returns:
- The string representation of this
Expression
-
-