Top Description Constructors Methods
org.eclipse.persistence.jpa.jpql.parser

public final Class ModExpression

extends AbstractDoubleEncapsulatedExpression
Class Inheritance
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)
Author
Pascal Filion
Since
2.3
Version
2.5

Constructor Summary

AccessConstructor and Description
public
ModExpression(AbstractExpression
The parent of this expression
parent)

Creates a new ModExpression.

Method Summary

Modifier and TypeMethod and Description
public void
accept(ExpressionVisitor
The ExpressionVisitor to visit this object
visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.
public JPQLQueryBNF
getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.
public String
parameterExpressionBNF(int
The position of the encapsulated Expression that needs to be parsed within the parenthesis, which starts at position 0
index)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractDoubleEncapsulatedExpression.parameterExpressionBNF.

Returns the BNF to be used to parse one of the encapsulated expression.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractDoubleEncapsulatedExpression:
acceptChildrenaddChildrenToaddOrderedEncapsulatedExpressionTobuildCollectionExpressionfindQueryBNFgetFirstExpressiongetSecondExpressionhasCommahasEncapsulatedExpressionhasFirstExpressionhasSecondExpressionhasSpaceAfterCommaisParsingCompleteisSecondExpressionOptionalparseEncapsulatedExpressionremoveEncapsulatedExpressiontoParsedTextEncapsulatedExpression

Constructor Detail

ModExpressionback to summary
public ModExpression(AbstractExpression parent)

Creates a new ModExpression.

Parameters
parent:AbstractExpression

The parent of this expression

Method Detail

acceptback to summary
public void accept(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.accept.

Visits this Expression by the given visitor.

Parameters
visitor:ExpressionVisitor

The ExpressionVisitor to visit this object

Annotations
@Override
getQueryBNFback to summary
public JPQLQueryBNF getQueryBNF()

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.getQueryBNF.

Returns the BNF of this Expression.

Returns:JPQLQueryBNF

The JPQLQueryBNF, which represents the grammar of this Expression

Annotations
@Override
parameterExpressionBNFback to summary
public String parameterExpressionBNF(int index)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractDoubleEncapsulatedExpression.parameterExpressionBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractDoubleEncapsulatedExpression.parameterExpressionBNF.

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

Parameters
index:int

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

Returns:String

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

Annotations
@Override