Module org.eclipse.persistence.jpa.jpql

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

Class ModExpression

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.parser.AbstractEncapsulatedExpression

org.eclipse.persistence.jpa.jpql.parser.AbstractDoubleEncapsulatedExpression

org.eclipse.persistence.jpa.jpql.parser.ModExpression

All Implemented Interfaces:

Expression

public final class ModExpression
extends AbstractDoubleEncapsulatedExpression

The modulo operation finds the remainder of division of one number by another.
It takes two integer arguments and returns an integer.
JPA 1.0, 2.0:

BNF: expression ::= MOD(simple_arithmetic_expression, simple_arithmetic_expression)

JPA 2.1:

BNF: expression ::= MOD(arithmetic_expression, arithmetic_expression)

Since:

2.3

Version:

2.5

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, CEILING, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DATE, DATETIME, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXP, EXTRACT, FALSE, FETCH, FIRST, FLOOR, 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, LN, LOCAL, 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, POWER, QUOTE, REGEXP, ROUND, SCN, SELECT, SET, SIGN, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIME, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Constructor Summary

Constructors

Constructor	Description
ModExpression(AbstractExpression parent)	Creates a new ModExpression.

Method Summary

Modifier and Type	Method	Description
void	accept(ExpressionVisitor visitor)	Visits this Expression by the given visitor.
JPQLQueryBNF	getQueryBNF()	Returns the BNF of this Expression.
String	parameterExpressionBNF(int index)	Returns the BNF to be used to parse one of the encapsulated expression.

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

acceptChildren, addChildrenTo, addOrderedEncapsulatedExpressionTo, buildCollectionExpression, findQueryBNF, getFirstExpression, getSecondExpression, hasComma, hasEncapsulatedExpression, hasFirstExpression, hasSecondExpression, hasSpaceAfterComma, isParsingComplete, isSecondExpressionOptional, parseEncapsulatedExpression, removeEncapsulatedExpression, toParsedTextEncapsulatedExpression

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

addOrderedChildrenTo, areLogicalIdentifiersSupported, getActualIdentifier, getIdentifier, hasLeftParenthesis, hasRightParenthesis, hasSpaceAfterIdentifier, parse, shouldParseRightParenthesis, toParsedText

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

acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, 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

ModExpression

public ModExpression(AbstractExpression parent)

Creates a new ModExpression.

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

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

parameterExpressionBNF

public String parameterExpressionBNF(int index)

Description copied from class: AbstractDoubleEncapsulatedExpression

Returns the BNF to be used to parse one of the encapsulated expression.

Specified by:

parameterExpressionBNF in class AbstractDoubleEncapsulatedExpression

Parameters:

index - The position of the encapsulated Expression that needs to be parsed within the parenthesis, which starts at position 0

Returns:

The BNF to be used to parse one of the encapsulated expression