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

Class KeywordExpression

java.lang.Object

org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

org.eclipse.persistence.jpa.jpql.parser.KeywordExpression

All Implemented Interfaces:

Expression

public final class KeywordExpression
extends AbstractExpression

The expression representing some keywords: TRUE, FALSE or NULL.

EclipseLink 2.5 added two new identifiers: MINVALUE and MAXVALUE.

Version:

2.5

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
KeywordExpression(AbstractExpression parent, String identifier)	Creates a new KeywordExpression.

Method Summary

Modifier and Type	Method	Description
void	accept(ExpressionVisitor visitor)	Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor)	Visits the children of this Expression.
protected void	addOrderedChildrenTo(List<Expression> children)	Adds the children of this AbstractExpression to the given list.
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 this Expression.
String	getText()	Returns the encapsulated text of this AbstractExpression, which can be used in various ways, it can be a keyword, a literal, etc.
protected void	parse(WordParser wordParser, boolean tolerant)	Parses the query by starting at the current position, which is part of the given WordParser.
protected void	toParsedText(StringBuilder writer, boolean actual)	Generates a string representation of this Expression, 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, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

KeywordExpression

public KeywordExpression(AbstractExpression parent,
 String identifier)

Creates a new KeywordExpression.

Parameters:

parent - The parent of this expression

identifier - The identifier represented by 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

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

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