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

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

public final class InternalOrderByItemBNF

extends JPQLQueryBNF

The query BNF for an order by item.

JPA 1.0:

BNF: orderby_item ::= state_field_path_expression [ ASC | DESC ]

JPA 2.0

BNF: orderby_item ::= state_field_path_expression | result_variable [ ASC | DESC ]

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

static java.lang.String

ID The unique identifier for this InternalOrderByItemBNF.

Constructor Summary

InternalOrderByItemBNF()
Creates a new InternalOrderByItemBNF.

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.
(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, handleAggregate, handleCollection, 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 for this InternalOrderByItemBNF.

See Also:

Constant Field Values

Constructor Detail

InternalOrderByItemBNF

InternalOrderByItemBNF()

Creates a new InternalOrderByItemBNF.

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

initialize

void initialize()

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

Overrides:

initialize in class JPQLQueryBNF