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
ThisExpressionrepresents 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_TIMESTAMPThe 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
- Since:
- 2.3
-
-
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 voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.java.lang.StringgetActualIdentifier()Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.java.lang.StringgetText()Returns the encapsulated text of thisAbstractExpression, which can be used in various ways, it can be a keyword, a literal, etc.booleanisCurrentDate()Determines whether thisDateTimerepresents the JPQL identifierCURRENT_DATE.booleanisCurrentTime()Determines whether thisDateTimerepresents the JPQL identifierCURRENT_TIME.booleanisCurrentTimestamp()Determines whether thisDateTimerepresents the JPQL identifierCURRENT_TIMESTAMP.booleanisJDBCDate()Determines whether thisDateTimerepresents the JDBC escape syntax for date, time, timestamp formats.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.java.lang.StringtoActualText()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.java.lang.StringtoParsedText()Returns a string representation of thisExpressionand its children.protected voidtoParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
acceptUnknownVisitor, acceptUnknownVisitor, addChildrenTo, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, findQueryBNF, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, 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 thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto 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
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
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()
Returns the encapsulated text of thisAbstractExpression, which can be used in various ways, it can be a keyword, a literal, etc.- Overrides:
getTextin classAbstractExpression- Returns:
- Either the JPQL identifier for this
AbstractExpression, the literal it encapsulates or an empty string
-
isCurrentDate
public boolean isCurrentDate()
Determines whether thisDateTimerepresents the JPQL identifierCURRENT_DATE.- Returns:
trueif thisExpressionrepresentsCURRENT_DATE;falseotherwise
-
isCurrentTime
public boolean isCurrentTime()
Determines whether thisDateTimerepresents the JPQL identifierCURRENT_TIME.- Returns:
trueif thisExpressionrepresentsCURRENT_TIME;falseotherwise
-
isCurrentTimestamp
public boolean isCurrentTimestamp()
Determines whether thisDateTimerepresents the JPQL identifierCURRENT_TIMESTAMP.- Returns:
trueif thisExpressionrepresentsCURRENT_TIMESTAMP;falseotherwise
-
isJDBCDate
public boolean isJDBCDate()
Determines whether thisDateTimerepresents the JDBC escape syntax for date, time, timestamp formats.- Returns:
trueif thisExpressionrepresents a JDBC escape syntax;falseotherwise
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursortolerant- Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
-
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:
toActualTextin interfaceExpression- Overrides:
toActualTextin classAbstractExpression- Returns:
- The string representation of this
Expression
-
toParsedText
public java.lang.String toParsedText()
Returns a string representation of thisExpressionand 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:
toParsedTextin interfaceExpression- Overrides:
toParsedTextin classAbstractExpression- Returns:
- The string representation of this
Expression
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin classAbstractExpression- Parameters:
writer- The buffer used to append thisExpression's string representationactual- 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
-
-