Package org.eclipse.persistence.jpa.jpql.tools.model

Class EclipseLinkJPQLQueryBuilder

java.lang.Object

org.eclipse.persistence.jpa.jpql.tools.model.AbstractJPQLQueryBuilder

org.eclipse.persistence.jpa.jpql.tools.model.EclipseLinkJPQLQueryBuilder

All Implemented Interfaces:

IJPQLQueryBuilder

public final class EclipseLinkJPQLQueryBuilder
extends AbstractJPQLQueryBuilder

An implementation of IJPQLQueryBuilder that provides support based on the release of the Java Persistence functional specification defined in JSR-337 - Java Persistence 2.0. EclipseLink 2.1 provides additional support for 2 additional JPQL identifiers: FUNC and TREAT.

Version:

2.4

Author:

Pascal Filion

Since:

2.4

Constructor Summary

Constructors

Constructor	Description
EclipseLinkJPQLQueryBuilder(JPQLGrammar jpqlGrammar)	Creates a new EclipseLinkJPQLQueryBuilder.

Method Summary

Modifier and Type	Method	Description
protected EclipseLinkStateObjectBuilder	buildStateObjectBuilder()	Creates the builder that creates the StateObject for each Expression.
IConditionalExpressionStateObjectBuilder	buildStateObjectBuilder(AbstractConditionalClauseStateObject stateObject)	Creates a builder that can create a conditional expression programmatically.
EclipseLinkSelectExpressionStateObjectBuilder	buildStateObjectBuilder(SelectClauseStateObject stateObject)	Creates a builder that can create a select expression programmatically.
EclipseLinkSimpleSelectExpressionStateObjectBuilder	buildStateObjectBuilder(SimpleSelectClauseStateObject stateObject)	Creates a builder that can create a single select expression programmatically.
INewValueStateObjectBuilder	buildStateObjectBuilder(UpdateItemStateObject stateObject)	Creates a builder that can create a new value expression programmatically.
JPQLGrammar	getGrammar()	Returns the JPQLGrammar that is associated with this builder.
java.lang.String	toString()

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.AbstractJPQLQueryBuilder

buildCaseExpressionStateObjectBuilder, buildStateObject, buildStateObject, buildStateObject, getStateObjectBuilder, parse, parse, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

EclipseLinkJPQLQueryBuilder

public EclipseLinkJPQLQueryBuilder(JPQLGrammar jpqlGrammar)

Creates a new EclipseLinkJPQLQueryBuilder.

Parameters:

jpqlGrammar - The JPQLGrammar that will be used to parse JPQL queries, which has EclipseLink support

Method Detail

buildStateObjectBuilder

protected EclipseLinkStateObjectBuilder buildStateObjectBuilder()

Creates the builder that creates the StateObject for each Expression.

Specified by:

buildStateObjectBuilder in class AbstractJPQLQueryBuilder

Returns:

The builder that will be visiting the Expression

buildStateObjectBuilder

public IConditionalExpressionStateObjectBuilder buildStateObjectBuilder(AbstractConditionalClauseStateObject stateObject)

Creates a builder that can create a conditional expression programmatically. Once the expression is complete, IConditionalExpressionStateObjectBuilder.commit() will push the result onto the given state object.

Parameters:

stateObject - The clause for which a conditional expression can be created

Returns:

The builder of a conditional expression

buildStateObjectBuilder

public EclipseLinkSelectExpressionStateObjectBuilder buildStateObjectBuilder(SelectClauseStateObject stateObject)

Creates a builder that can create a select expression programmatically. Once the expression is complete, ISelectExpressionStateObjectBuilder.commit() will push the result onto the given state object.

Parameters:

stateObject - The clause for which one or many select expressions can be created

Returns:

The builder of a conditional expression

buildStateObjectBuilder

public EclipseLinkSimpleSelectExpressionStateObjectBuilder buildStateObjectBuilder(SimpleSelectClauseStateObject stateObject)

Creates a builder that can create a single select expression programmatically. Once the expression is complete, ISimpleSelectExpressionStateObjectBuilder.commit() will push the result onto the given state object.

Parameters:

stateObject - The clause for which a select expression can be created

Returns:

The builder of a conditional expression

buildStateObjectBuilder

public INewValueStateObjectBuilder buildStateObjectBuilder(UpdateItemStateObject stateObject)

Creates a builder that can create a new value expression programmatically. Once the expression is complete, INewValueStateObjectBuilder.commit() will push the result onto the given state object.

Parameters:

stateObject - The parent for which a new value expression can be created

Returns:

The builder of a new value expression

getGrammar

public JPQLGrammar getGrammar()

Returns the JPQLGrammar that is associated with this builder.

Returns:

The JPQLGrammar that was used to parse the JPQL query or JPQL fragments

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object