EclipseLink 2.4.0, build 'v20120308-r10963' API Reference

org.eclipse.persistence.queries
Interface JPAQueryBuilder

All Known Implementing Classes:
ANTLRQueryBuilder

public interface JPAQueryBuilder

This interface defines the entry point for implementing a JPA Query parsing system in EclipseLink.

By default, EclipseLink uses ANTLRQueryBuilder for parsing a query and converting it into a DatabaseQuery.

Third-parties can implement this interface and provide a different JPQL parsing system if required. The JPAQueryBuilder implementing class can be registered via a persistence unit property and the implementation class must have a public, zero-arg constructor.

Version:
2.2
See Also:
PersistenceUnitProperties#JPQL_QUERY_BUILDER, PersistenceUnitProperties#JPQL_QUERY_VALIDATION
Author:
John Bracken, Pascal Filion
Since:
2.2

Method Summary
 DatabaseQuery buildQuery(java.lang.String jpqlQuery, org.eclipse.persistence.internal.sessions.AbstractSession session)
          Creates a fully initialized DatabaseQuery by parsing the given Java Persistence query.
 void populateQuery(java.lang.String jpqlQuery, DatabaseQuery query, org.eclipse.persistence.internal.sessions.AbstractSession session)
          Populates an existing DatabaseQuery by parsing the given Java Persistence query.
 

Method Detail

buildQuery

DatabaseQuery buildQuery(java.lang.String jpqlQuery,
                         org.eclipse.persistence.internal.sessions.AbstractSession session)
Creates a fully initialized DatabaseQuery by parsing the given Java Persistence query.

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 criteria
session - The EclipseLink AbstractSession that this query will execute against
Returns:
The fully initialized DatabaseQuery

populateQuery

void populateQuery(java.lang.String jpqlQuery,
                   DatabaseQuery query,
                   org.eclipse.persistence.internal.sessions.AbstractSession session)
Populates an existing DatabaseQuery by parsing the given Java Persistence query.

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 criteria
session - The EclipseLink AbstractSession that this query will execute against

EclipseLink 2.4.0, build 'v20120308-r10963' API Reference