EclipseLink 2.4.0, build 'v20120319-r11014' API Reference

org.eclipse.persistence.queries
Class ANTLRQueryBuilder

java.lang.Object
  extended by org.eclipse.persistence.queries.ANTLRQueryBuilder
All Implemented Interfaces:
JPAQueryBuilder

public final class ANTLRQueryBuilder
extends java.lang.Object
implements JPAQueryBuilder

This class defines the default JPAQueryBuilder implementation that uses an Antlr-based parser and DatabaseQuery conversion mechanism.

Version:
2.4
See Also:
JPQLParser, JPQLParser, JPQLParserFactory, JPAQueryBuilder, JPAQueryBuilderManager
Author:
John Bracken
Since:
2.2

Constructor Summary
ANTLRQueryBuilder()
          Creates a new ANTLRQueryBuilder.
 
Method Summary
 DatabaseQuery buildQuery(java.lang.CharSequence jpqlQuery, org.eclipse.persistence.internal.sessions.AbstractSession session)
          Creates a fully initialized DatabaseQuery by parsing the given JPQL query.
 Expression buildSelectionCriteria(java.lang.String entityName, java.lang.String additionalCriteria, org.eclipse.persistence.internal.sessions.AbstractSession session)
          
 void populateQuery(java.lang.CharSequence jpqlQuery, DatabaseQuery query, org.eclipse.persistence.internal.sessions.AbstractSession session)
          Populates the given DatabaseQuery by parsing the given JPQL query.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ANTLRQueryBuilder

public ANTLRQueryBuilder()
Creates a new ANTLRQueryBuilder.

Method Detail

buildQuery

public DatabaseQuery buildQuery(java.lang.CharSequence jpqlQuery,
                                org.eclipse.persistence.internal.sessions.AbstractSession session)
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(java.lang.String entityName,
                                         java.lang.String additionalCriteria,
                                         org.eclipse.persistence.internal.sessions.AbstractSession session)


populateQuery

public void populateQuery(java.lang.CharSequence jpqlQuery,
                          DatabaseQuery query,
                          org.eclipse.persistence.internal.sessions.AbstractSession session)
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

EclipseLink 2.4.0, build 'v20120319-r11014' API Reference