Module eclipselink

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

Class JPQLGrammar3_1

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar3_1

All Implemented Interfaces:

JPQLGrammar

public class JPQLGrammar3_1
extends AbstractJPQLGrammar

This JPQLGrammar provides support for parsing JPQL queries defined in Jakarta Persistence 3.1.

 functions_returning_numerics ::= ABS(arithmetic_expression) |
                                  CEILING(arithmetic_expression) |
                                  EXP(arithmetic_expression) |
                                  FLOOR(arithmetic_expression) |
                                  LN(arithmetic_expression) |
                                  MOD(arithmetic_expression, arithmetic_expression) |
                                  POWER(arithmetic_expression, arithmetic_expression) |
                                  ROUND(arithmetic_expression, arithmetic_expression) |
                                  SIGN(arithmetic_expression) |
                                  SQRT(arithmetic_expression) |
                                  SIZE(collection_valued_path_expression) |
                                  INDEX(identification_variable) |
                                  extract_datetime_field

 extract_datetime_field := EXTRACT(datetime_field FROM datetime_expression)

 datetime_field := identification_variable

 functions_returning_datetime ::= CURRENT_DATE | CURRENT_TIME | CURRENT_TIMESTAMP |
                                  LOCAL local_datetime_type |
                                  extract_datetime_par

 local_datetime_type ::= DATE |   ..... matches Java java.time.LocalDate
                         TIME |   ..... matches Java java.time.LocalTime
                         DATETIME ..... matches Java java.time.LocalDateTime
 

Constructor Summary

Constructors

Constructor	Description
JPQLGrammar3_1()	Creates an insance of Jakarta Persistence 3.1 JPQL grammar.

Method Summary

Modifier and Type	Method	Description
protected JPQLGrammar	buildBaseGrammar()	Creates the base JPQLGrammar this one extends, if one exists.
static void	extend(AbstractJPQLGrammar jpqlGrammar)	Extends the given JPQLGrammar with the information of this one without instantiating the base JPQLGrammar.
JPAVersion	getJPAVersion()	Returns the JPAVersion of the Java Persistence supported by this grammar.
String	getProvider()	Returns the persistence provider name.
String	getProviderVersion()	Returns the version of the persistence provider.
protected void	initializeBNFs()	Registers the JPQL query BNFs defining the JPQL grammar.
protected void	initializeExpressionFactories()	Registers the ExpressionFactories required to properly parse JPQL queries.
protected void	initializeIdentifiers()	Registers the JPQL identifiers support by this JPQLGrammar.
static JPQLGrammar	instance()	Returns the singleton instance of the default implementation of JPQLGrammar which provides support for the JPQL grammar defined in the Jakarta Persistence 3.1 functional specification.
String	toString()

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

addChildBNF, addChildFactory, addIdentifier, addIdentifiers, buildExpressionRegistry, getBaseGrammar, getExpressionRegistry, initialize, registerBNF, registerFactory, registerIdentifierRole, registerIdentifierVersion, setFallbackBNFId, setFallbackExpressionFactoryId, setHandleCollection, setHandleNestedArray, setHandleSubExpression

Methods inherited from class java.lang.Object

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

Constructor Detail

JPQLGrammar3_1

public JPQLGrammar3_1()

Creates an insance of Jakarta Persistence 3.1 JPQL grammar.

Method Detail

extend

public static void extend(AbstractJPQLGrammar jpqlGrammar)

Extends the given JPQLGrammar with the information of this one without instantiating the base JPQLGrammar.

Parameters:

jpqlGrammar - The JPQLGrammar to extend with the content of this one without instantiating the base JPQLGrammar

instance

public static JPQLGrammar instance()

Returns the singleton instance of the default implementation of JPQLGrammar which provides support for the JPQL grammar defined in the Jakarta Persistence 3.1 functional specification.

Returns:

The JPQLGrammar that only has support for Jakarta Persistence 3.1

buildBaseGrammar

protected JPQLGrammar buildBaseGrammar()

Description copied from class: AbstractJPQLGrammar

Creates the base JPQLGrammar this one extends, if one exists.

IMPORTANT: The singleton instance of any JPQLGrammar (for example JPQLGrammar1_0.instance() cannot be used, the API does not support extending it, a new instance has to be created.

Specified by:

buildBaseGrammar in class AbstractJPQLGrammar

Returns:

The base JPQLGrammar or null if there is no base grammar

getJPAVersion

public JPAVersion getJPAVersion()

Description copied from interface: JPQLGrammar

Returns the JPAVersion of the Java Persistence supported by this grammar.

Returns:

The JPA version supported by this grammar

getProvider

public String getProvider()

Description copied from interface: JPQLGrammar

Returns the persistence provider name.

Returns:

The name of the persistence provider, null should never be returned

getProviderVersion

public String getProviderVersion()

Description copied from interface: JPQLGrammar

Returns the version of the persistence provider.

Returns:

The version of the persistence provider, if one is extending the default JPQL grammar defined in the Java Persistence specification, otherwise returns an empty string

initializeBNFs

protected void initializeBNFs()

Description copied from class: AbstractJPQLGrammar

Registers the JPQL query BNFs defining the JPQL grammar.

Specified by:

initializeBNFs in class AbstractJPQLGrammar

initializeExpressionFactories

protected void initializeExpressionFactories()

Description copied from class: AbstractJPQLGrammar

Registers the ExpressionFactories required to properly parse JPQL queries. An ExpressionFactory is responsible to create an Expression object that represents a portion of the JPQL query.

Specified by:

initializeExpressionFactories in class AbstractJPQLGrammar

initializeIdentifiers

protected void initializeIdentifiers()

Description copied from class: AbstractJPQLGrammar

Registers the JPQL identifiers support by this JPQLGrammar. The registration involves registering the JPAVersion and the IdentifierRole.

Specified by:

initializeIdentifiers in class AbstractJPQLGrammar

toString

public String toString()

Overrides:

toString in class Object