org.eclipse.persistence.jpa.jpql.parser

Class AbstractJPQLGrammar

java.lang.Object

org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar

All Implemented Interfaces:

JPQLGrammar

Direct Known Subclasses:

EclipseLinkJPQLGrammar1, EclipseLinkJPQLGrammar2_0, EclipseLinkJPQLGrammar2_1, EclipseLinkJPQLGrammar2_2, EclipseLinkJPQLGrammar2_3, EclipseLinkJPQLGrammar2_4, JPQLGrammar1_0, JPQLGrammar2_0, JPQLGrammar2_1

public abstract class AbstractJPQLGrammar
extends java.lang.Object
implements JPQLGrammar

The abstract definition of a JPQLGrammar. The grammar defines how a JPQL query is parsed, which is based on the BNF defined for that grammar. Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.4

Version:

2.4

Author:

Pascal Filion

Method Summary

Modifier and Type	Method and Description
void	addChildBNF(java.lang.String queryBNFId, java.lang.String childQueryBNFId) Adds to the given query BNF a child BNF.
void	addChildFactory(java.lang.String queryBNFId, java.lang.String childExpressionFactoryId) Adds to the given unique identifier of an ExpressionFactory to the given query BNF.
void	addIdentifier(java.lang.String expressionFactoryId, java.lang.String identifier) Adds the given JPQL identifier to this factory.
void	addIdentifiers(java.lang.String expressionFactoryId, java.lang.String... identifiers) Adds the given JPQL identifiers to this factory.
JPQLGrammar	getBaseGrammar() Creates the base JPQLGrammar this one extends.
ExpressionRegistry	getExpressionRegistry() Returns the registry containing the JPQLQueryBNFs and the ExpressionFactories that are used to properly parse a JPQL query.
void	setFallbackBNFId(java.lang.String queryBNFId, java.lang.String fallbackBNFId) When parsing the query and no JPQLQueryBNFs can help to parse the query, then it will fall back on the given one.
void	setFallbackExpressionFactoryId(java.lang.String queryBNFId, java.lang.String fallbackExpressionFactoryId) Sets the unique identifier of the ExpressionFactory to use when the fall back BNF ID is not null.
void	setHandleSubExpression(java.lang.String queryBNFId, boolean handleSubExpression)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar

getJPAVersion, getProviderVersion

Method Detail

addChildBNF

public void addChildBNF(java.lang.String queryBNFId,
                        java.lang.String childQueryBNFId)

Adds to the given query BNF a child BNF.

Parameters:

queryBNFId - The unique identifier of the parent BNF to add a child BNF

childQueryBNFId - The unique identifier of the child to add to the parent BNF

addChildFactory

public void addChildFactory(java.lang.String queryBNFId,
                            java.lang.String childExpressionFactoryId)

Adds to the given unique identifier of an ExpressionFactory to the given query BNF.

Parameters:

queryBNFId - The unique identifier of the parent BNF

childExpressionFactoryId - The unique identifier of the ExpressionFactory to add to the given query BNF

addIdentifier

public void addIdentifier(java.lang.String expressionFactoryId,
                          java.lang.String identifier)

Adds the given JPQL identifier to this factory.

Parameters:

expressionFactoryId - The unique identifier of the ExpressionFactory to add more JPQL identifiers

identifier - The JPQL identifier this factory will parse

addIdentifiers

public void addIdentifiers(java.lang.String expressionFactoryId,
                           java.lang.String... identifiers)

Adds the given JPQL identifiers to this factory.

Parameters:

expressionFactoryId - The unique identifier of the ExpressionFactory to add more JPQL identifiers

identifiers - The JPQL identifiers this factory will parse

getBaseGrammar

public JPQLGrammar getBaseGrammar()

Creates the base JPQLGrammar this one extends.

Returns:

The base JPQLGrammar or null if this is the base grammar

getExpressionRegistry

public ExpressionRegistry getExpressionRegistry()

Returns the registry containing the JPQLQueryBNFs and the ExpressionFactories that are used to properly parse a JPQL query.

Specified by:

getExpressionRegistry in interface JPQLGrammar

Returns:

The registry containing the information related to the JPQL grammar

setFallbackBNFId

public void setFallbackBNFId(java.lang.String queryBNFId,
                             java.lang.String fallbackBNFId)

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

Parameters:

queryBNFId - The unique identifier of the BNF to modify its fallback BNF unique identifier

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

setHandleSubExpression

public void setHandleSubExpression(java.lang.String queryBNFId,
                                   boolean handleSubExpression)

setFallbackExpressionFactoryId

public void setFallbackExpressionFactoryId(java.lang.String queryBNFId,
                                           java.lang.String fallbackExpressionFactoryId)

Sets 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.

Parameters:

queryBNFId - The unique identifier of the BNF to modify its fallback expression factory unique identifier