Package org.eclipse.persistence.internal.jpa.jpql

Class HermesParser

java.lang.Object

org.eclipse.persistence.internal.jpa.jpql.HermesParser

All Implemented Interfaces:

JPAQueryBuilder

public final class HermesParser
extends Object
implements JPAQueryBuilder

This class compiles a JPQL query into a DatabaseQuery. If validation is not turned off, then the JPQL query will be validated based on the grammar related to the validation level and will also be validated based on the semantic (context).

The validation level determines how to validate the JPQL query. It checks if any specific feature is allowed. For instance, if the JPQL query has functions defined for EclipseLink grammar but the validation level is set for generic JPA, then an exception will be thrown indicating the function cannot be used.

Since:

2.3

Version:

2.5

Author:

John Bracken, Pascal Filion

See Also:

JPQLExpression

Constructor Summary

Constructors

Constructor	Description
HermesParser()	Creates a new HermesParser.

Method Summary

Modifier and Type	Method	Description
DatabaseQuery	buildQuery(CharSequence jpqlQuery, AbstractSession session)	Creates a fully initialized DatabaseQuery by parsing the given JPQL query.
Expression	buildSelectionCriteria(String entityName, String selectionCriteria, AbstractSession session)	Creates a new Expression that represents the given selection criteria.
void	populateQuery(CharSequence jpqlQuery, DatabaseQuery query, AbstractSession session)	Populates the given DatabaseQuery by parsing the given JPQL query.
void	setValidationLevel(String validationLevel)	Allow the parser validation level to be set.

Methods inherited from class java.lang.Object

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

Constructor Detail

HermesParser

public HermesParser()

Creates a new HermesParser.

Method Detail

buildQuery

public DatabaseQuery buildQuery(CharSequence jpqlQuery,
                                AbstractSession session)

Description copied from interface: JPAQueryBuilder

Creates a fully initialized DatabaseQuery by parsing the given JPQL query.

Specified by:

buildQuery in interface JPAQueryBuilder

Parameters:

jpqlQuery - A non-null string representation of the query to parse and to convert into a DatabaseQuery

session - The EclipseLink AbstractSession that this query will execute against

Returns:

The fully initialized DatabaseQuery

buildSelectionCriteria

public Expression buildSelectionCriteria(String entityName,
                                         String selectionCriteria,
                                         AbstractSession session)

Description copied from interface: JPAQueryBuilder

Creates a new Expression that represents the given selection criteria.

Specified by:

buildSelectionCriteria in interface JPAQueryBuilder

Parameters:

entityName - The name of the entity for which a criteria is created

selectionCriteria - The string representation of a conditional expression to parse

session - The EclipseLink AbstractSession that this query will execute against

Returns:

The fully initialized Expression

populateQuery

public void populateQuery(CharSequence jpqlQuery,
                          DatabaseQuery query,
                          AbstractSession session)

Description copied from interface: JPAQueryBuilder

Populates the given DatabaseQuery by parsing the given JPQL query.

Specified by:

populateQuery in interface JPAQueryBuilder

Parameters:

jpqlQuery - A non-null string representation of the query to parse and to convert into a DatabaseQuery

query - The query to populate with the derived JPQL query

session - The EclipseLink AbstractSession that this query will execute against

setValidationLevel

public void setValidationLevel(String validationLevel)

Description copied from interface: JPAQueryBuilder

Allow the parser validation level to be set.

Specified by:

setValidationLevel in interface JPAQueryBuilder

Parameters:

validationLevel - The validation levels are defined in ParserValidationType