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

public Class JPQLGrammar3_1

extends AbstractJPQLGrammar
Class Inheritance
Imports
org.eclipse.persistence.jpa.jpql.ExpressionTools, .JPAVersion
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

Field Summary

Modifier and TypeField and Description
private static final JPQLGrammar
INSTANCE

The singleton instance of this JPQLGrammar3_1.

Constructor Summary

AccessConstructor and Description
public
JPQLGrammar3_1()

Creates an insance of Jakarta Persistence 3.1 JPQL grammar.

private
JPQLGrammar3_1(AbstractJPQLGrammar
The JPQLGrammar to extend with the content of this one without instantiating the base JPQLGrammar
jpqlGrammar)

Creates an instance of Jakarta Persistence 3.1 JPQL grammar.

Method Summary

Modifier and TypeMethod and Description
protected JPQLGrammar
buildBaseGrammar()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.buildBaseGrammar.

Creates the base JPQLGrammar this one extends, if one exists.
public static void
extend(AbstractJPQLGrammar
The JPQLGrammar to extend with the content of this one without instantiating the base JPQLGrammar
jpqlGrammar)

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

public JPAVersion
getJPAVersion()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getJPAVersion.

Returns the JPAVersion of the Java Persistence supported by this grammar.
public String
getProvider()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProvider.

Returns the persistence provider name.
public String
getProviderVersion()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProviderVersion.

Returns the version of the persistence provider.
protected void
initializeBNFs()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeBNFs.

Registers the JPQL query BNFs defining the JPQL grammar.
protected void
initializeExpressionFactories()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeExpressionFactories.

Registers the ExpressionFactories required to properly parse JPQL queries.
protected void
initializeIdentifiers()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeIdentifiers.

Registers the JPQL identifiers support by this JPQLGrammar.
public static JPQLGrammar

Returns:

The JPQLGrammar that only has support for Jakarta Persistence 3.1
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.

private void
registerExpressionFactory(final ExpressionFactory factory, final String queryBNFId, final String identifier)

private void
registerFunctionIdentifier(final String identifier)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar:
addChildBNFaddChildFactoryaddIdentifieraddIdentifiersbuildExpressionRegistrygetBaseGrammargetExpressionRegistryinitializeregisterBNFregisterFactoryregisterIdentifierRoleregisterIdentifierVersionsetFallbackBNFIdsetFallbackExpressionFactoryIdsetHandleCollectionsetHandleNestedArraysetHandleSubExpression

Field Detail

INSTANCEback to summary
private static final JPQLGrammar INSTANCE

The singleton instance of this JPQLGrammar3_1.

Constructor Detail

JPQLGrammar3_1back to summary
public JPQLGrammar3_1()

Creates an insance of Jakarta Persistence 3.1 JPQL grammar.

JPQLGrammar3_1back to summary
private JPQLGrammar3_1(AbstractJPQLGrammar jpqlGrammar)

Creates an instance of Jakarta Persistence 3.1 JPQL grammar.

Parameters
jpqlGrammar:AbstractJPQLGrammar

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

Method Detail

buildBaseGrammarback to summary
protected JPQLGrammar buildBaseGrammar()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.buildBaseGrammar.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.buildBaseGrammar.

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

Important Note

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.

Returns:JPQLGrammar

The base JPQLGrammar or null if there is no base grammar

Annotations
@Override
extendback to summary
public static void extend(AbstractJPQLGrammar jpqlGrammar)

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

Parameters
jpqlGrammar:AbstractJPQLGrammar

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

getJPAVersionback to summary
public JPAVersion getJPAVersion()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getJPAVersion.

Doc from org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getJPAVersion.

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

Returns:JPAVersion

The JPA version supported by this grammar

Annotations
@Override
getProviderback to summary
public String getProvider()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProvider.

Doc from org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProvider.

Returns the persistence provider name.

Returns:String

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

Annotations
@Override
getProviderVersionback to summary
public String getProviderVersion()

Implements org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProviderVersion.

Doc from org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar.getProviderVersion.

Returns the version of the persistence provider.

Returns:String

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

Annotations
@Override
initializeBNFsback to summary
protected void initializeBNFs()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeBNFs.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeBNFs.

Registers the JPQL query BNFs defining the JPQL grammar.

Annotations
@Override
initializeExpressionFactoriesback to summary
protected void initializeExpressionFactories()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeExpressionFactories.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeExpressionFactories.

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.

Annotations
@Override
initializeIdentifiersback to summary
protected void initializeIdentifiers()

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeIdentifiers.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractJPQLGrammar.initializeIdentifiers.

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

Annotations
@Override
instanceback to summary
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:JPQLGrammar

The JPQLGrammar that only has support for Jakarta Persistence 3.1

registerExpressionFactoryback to summary
private void registerExpressionFactory(final ExpressionFactory factory, final String queryBNFId, final String identifier)
registerFunctionIdentifierback to summary
private void registerFunctionIdentifier(final String identifier)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override