org.eclipse.persistence.jpa.internal.jpql.parser
Class GroupByItemBNF

java.lang.Object
org.eclipse.persistence.jpa.internal.jpql.parser.JPQLQueryBNF
org.eclipse.persistence.jpa.internal.jpql.parser.GroupByItemBNF

public final class GroupByItemBNF

extends JPQLQueryBNF

The query BNF for a group by item expression.

BNF: groupby_item ::= single_valued_path_expression | identification_variable

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

static java.lang.String

ID The unique identifier of this BNF rule.

Constructor Summary

GroupByItemBNF()
Creates a new GroupByItemBNF.

Method Summary

(package private) java.lang.String	getFallbackBNFId() When parsing the query and no JPQLQueryBNFs can help to parse the query, then it will fall back on this one.
(package private) java.lang.String	getFallbackExpressionFactoryId() Returns the unique identifier of the ExpressionFactory to use when the fall back BNF ID is not null.
boolean	handleAggregate() Determines whether the Expression handles a collection of sub-expressions that are aggregated by logical or arithmetic operators.
boolean	handleCollection() Determines whether the Expression handles a collection of sub-expressions that are separated by commas.
(package private) void	initialize() Initializes this BNF rule by registering child BNF rules and expression factories.

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.JPQLQueryBNF

addChildren, children, expressionFactory, expressionFactoryIds, getId, hasIdentifier, identifiers, isCompound, nonCompoundChildren, registerChild, registerExpressionFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

The unique identifier of this BNF rule.

See Also:

Constant Field Values

Constructor Detail

GroupByItemBNF

GroupByItemBNF()

Creates a new GroupByItemBNF.

Method Detail

getFallbackBNFId

java.lang.String getFallbackBNFId()

When parsing the query and no JPQLQueryBNFs can help to parse the query, then it will fall back on this one.

Overrides:

getFallbackBNFId in class JPQLQueryBNF

Returns:

The unique identifier of the JPQLQueryBNF to use in the last resort

getFallbackExpressionFactoryId

java.lang.String getFallbackExpressionFactoryId()

Returns the unique identifier of the ExpressionFactory to use when the fall back BNF ID is not null. This will be used to parse a portion of the query when the registered expression factories cannot parse it.

Note: This method is only called if JPQLQueryBNF.getFallbackBNFId() does not return null.

Overrides:

getFallbackExpressionFactoryId in class JPQLQueryBNF

Returns:

The unique identifier of the ExpressionFactory

handleAggregate

public boolean handleAggregate()

Determines whether the Expression handles a collection of sub-expressions that are aggregated by logical or arithmetic operators.

Overrides:

handleAggregate in class JPQLQueryBNF

Returns:

true if the sub-expression to parse might have several logical and/or arithmetic expressions; false otherwise

handleCollection

public boolean handleCollection()

Determines whether the Expression handles a collection of sub-expressions that are separated by commas.

Overrides:

handleCollection in class JPQLQueryBNF

Returns:

true if the sub-expression to parse might have several sub-expressions separated by commas; false otherwise

initialize

void initialize()

Initializes this BNF rule by registering child BNF rules and expression factories.

Overrides:

initialize in class JPQLQueryBNF