org.eclipse.persistence.jpa.jpql.parser

Class ArithmeticFactor

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.parser.ArithmeticFactor

All Implemented Interfaces:

Expression

public final class ArithmeticFactor
extends AbstractExpression

This expression simply adds a plus or minus sign to the arithmetic primary expression.

BNF: arithmetic_factor ::= [{+|-}] arithmetic_primary

Since:

2.3

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 and Description
ArithmeticFactor(AbstractExpression parent, java.lang.String arithmeticFactor) Creates a new ArithmeticFactor.

Method Summary

Modifier and Type	Method and Description
void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
JPQLQueryBNF	findQueryBNF(Expression expression) Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
Expression	getExpression() Returns the Expression representing the arithmetic primary.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
boolean	hasExpression() Determines whether the arithmetic primary was parsed.
boolean	hasSpaceAfterArithmeticOperator() Determines whether a whitespace was parsed after the arithmetic operator.
boolean	isNegative() Determines if the arithmetic primary is prepended with the minus sign.
boolean	isPositive() Determines if the arithmetic primary is prepended with the plus sign.

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression

children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArithmeticFactor

public ArithmeticFactor(AbstractExpression parent,
                        java.lang.String arithmeticFactor)

Creates a new ArithmeticFactor.

Parameters:

parent - The parent of this expression

arithmeticFactor - The arithmetic factor, which is either '+' or '-'

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The ExpressionVisitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)

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.

findQueryBNF

public JPQLQueryBNF findQueryBNF(Expression expression)

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Specified by:

findQueryBNF in interface Expression

Overrides:

findQueryBNF in class AbstractExpression

Parameters:

expression - The Expression that is a descendant of this one

Returns:

The JPQLQueryBNF that was used to parse the given expression

getExpression

public Expression getExpression()

Returns the Expression representing the arithmetic primary.

Returns:

The expression representing the arithmetic primary

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

hasExpression

public boolean hasExpression()

Determines whether the arithmetic primary was parsed.

Returns:

true the arithmetic primary was parsed; false if nothing was parsed

hasSpaceAfterArithmeticOperator

public boolean hasSpaceAfterArithmeticOperator()

Determines whether a whitespace was parsed after the arithmetic operator.

Returns:

true if there was a whitespace after the arithmetic operator; false otherwise

isNegative

public boolean isNegative()

Determines if the arithmetic primary is prepended with the minus sign.

Returns:

true if the expression is prepended with '-'; false otherwise

isPositive

public boolean isPositive()

Determines if the arithmetic primary is prepended with the plus sign.

Returns:

true if the expression is prepended with '+'; false otherwise