EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference

org.eclipse.persistence.jpa.jpql.parser
Class DefaultEclipseLinkJPQLGrammar

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.parser.DefaultEclipseLinkJPQLGrammar
All Implemented Interfaces:
JPQLGrammar

public final class DefaultEclipseLinkJPQLGrammar
extends java.lang.Object
implements JPQLGrammar

This JPQL grammar provides support for parsing JPQL queries defined by the JPA 2.1 functional specification and the EclipseLink 2.5.

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.

Version:
2.5
See Also:
JPQLGrammar2_1, EclipseLinkJPQLGrammar2_5
Author:
Pascal Filion
Since:
2.4

Field Summary
static java.lang.String PROVIDER_NAME
          The persistence provider name: EclipseLink.
 
Method Summary
 ExpressionRegistry getExpressionRegistry()
          Returns the registry containing the JPQLQueryBNFs and the ExpressionFactories that are used to properly parse a JPQL query.
 JPAVersion getJPAVersion()
          Returns the JPAVersion of the Java Persistence supported by this grammar.
 java.lang.String getProvider()
          Returns the persistence provider name.
 java.lang.String getProviderVersion()
          Returns the version of the persistence provider.
static JPQLGrammar instance()
          Returns the singleton instance of this class.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PROVIDER_NAME

public static final java.lang.String PROVIDER_NAME
The persistence provider name: EclipseLink.

See Also:
Constant Field Values
Method Detail

instance

public static JPQLGrammar instance()
Returns the singleton instance of this class.

Returns:
The latest JPQLGrammar that supports EclipseLink

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

getJPAVersion

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

Specified by:
getJPAVersion in interface JPQLGrammar
Returns:
The JPA version supported by this grammar

getProvider

public java.lang.String getProvider()
Returns the persistence provider name.

Specified by:
getProvider in interface JPQLGrammar
Returns:
The name of the persistence provider, null should never be returned

getProviderVersion

public java.lang.String getProviderVersion()
Returns the version of the persistence provider.

Specified by:
getProviderVersion in interface JPQLGrammar
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

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object

EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference