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

public final Class EclipseLinkJPQLGrammar2_0

extends AbstractJPQLGrammar
Class Inheritance
Annotations
@SuppressWarnings:nls
Imports
org.eclipse.persistence.jpa.jpql.EclipseLinkVersion, .JPAVersion

This JPQLGrammar provides support for parsing JPQL queries defined in JSR-337 - Java Persistence 2.0. EclipseLink 2.0 does not add any additional support.

The BNFs of the additional support are the following: 
 in_expression ::= in_expression_expression [NOT] IN { ( in_item {, in_item}* ) | (subquery) | collection_valued_input_parameter }

in_expression_expression ::= { state_field_path_expression | type_discriminator |
                               single_valued_input_parameter | identification_variable }

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.

Author
Pascal Filion
Since
2.4
Version
2.5

Field Summary

Modifier and TypeField and Description
private static final JPQLGrammar
INSTANCE

The singleton instance of this EclipseLinkJPQLGrammar2_0.

public static final EclipseLinkVersion
VERSION

The EclipseLink version, which is 2.0.

Constructor Summary

AccessConstructor and Description
public
EclipseLinkJPQLGrammar2_0()

Creates a new EclipseLinkJPQLGrammar2_0.

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

Creates a new EclipseLinkJPQLGrammar2_0.

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 EclipseLinkJPQLGrammar2_0
instance()

Returns the singleton instance of this class.

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

VERSIONback to summary
public static final EclipseLinkVersion VERSION

The EclipseLink version, which is 2.0.

Constructor Detail

EclipseLinkJPQLGrammar2_0back to summary
public EclipseLinkJPQLGrammar2_0()

Creates a new EclipseLinkJPQLGrammar2_0.

EclipseLinkJPQLGrammar2_0back to summary
private EclipseLinkJPQLGrammar2_0(AbstractJPQLGrammar jpqlGrammar)

Creates a new EclipseLinkJPQLGrammar2_0.

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 this class.

Returns:JPQLGrammar

The EclipseLinkJPQLGrammar2_0

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