Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.tools.model

public final Class EclipseLinkJPQLQueryBuilder

extends AbstractJPQLQueryBuilder
Class Inheritance
Annotations
@SuppressWarnings:nls
Imports
org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar, org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractConditionalClauseStateObject, .SelectClauseStateObject, .SimpleSelectClauseStateObject, .UpdateItemStateObject
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.
Author
Pascal Filion
Since
2.4
Version
2.4

Field Summary

Modifier and TypeField and Description
private final JPQLGrammar
jpqlGrammar

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

Constructor Summary

AccessConstructor and Description
public
EclipseLinkJPQLQueryBuilder(JPQLGrammar
The JPQLGrammar that will be used to parse JPQL queries, which has EclipseLink support
jpqlGrammar)

Creates a new EclipseLinkJPQLQueryBuilder.

Method Summary

Modifier and TypeMethod and Description
protected EclipseLinkStateObjectBuilder
buildStateObjectBuilder()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.AbstractJPQLQueryBuilder.buildStateObjectBuilder.

Creates the builder that creates the StateObject for each Expression.
public IConditionalExpressionStateObjectBuilder
buildStateObjectBuilder(AbstractConditionalClauseStateObject
The clause for which a conditional expression can be created
stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

Creates a builder that can create a conditional expression programmatically.
public EclipseLinkSelectExpressionStateObjectBuilder
buildStateObjectBuilder(SelectClauseStateObject
The clause for which one or many select expressions can be created
stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

Creates a builder that can create a select expression programmatically.
public EclipseLinkSimpleSelectExpressionStateObjectBuilder
buildStateObjectBuilder(SimpleSelectClauseStateObject
The clause for which a select expression can be created
stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

Creates a builder that can create a single select expression programmatically.
public INewValueStateObjectBuilder
buildStateObjectBuilder(UpdateItemStateObject
The parent for which a new value expression can be created
stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

Creates a builder that can create a new value expression programmatically.
public JPQLGrammar
getGrammar()

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.getGrammar.

Returns the JPQLGrammar that is associated with this builder.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from org.eclipse.persistence.jpa.jpql.tools.model.AbstractJPQLQueryBuilder:
buildCaseExpressionStateObjectBuilderbuildStateObjectbuildStateObjectbuildStateObjectgetStateObjectBuilderparseparsewrap

Field Detail

jpqlGrammarback to summary
private final JPQLGrammar jpqlGrammar

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

Constructor Detail

EclipseLinkJPQLQueryBuilderback to summary
public EclipseLinkJPQLQueryBuilder(JPQLGrammar jpqlGrammar)

Creates a new EclipseLinkJPQLQueryBuilder.

Parameters
jpqlGrammar:JPQLGrammar

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

Method Detail

buildStateObjectBuilderback to summary
protected EclipseLinkStateObjectBuilder buildStateObjectBuilder()

Implements abstract org.eclipse.persistence.jpa.jpql.tools.model.AbstractJPQLQueryBuilder.buildStateObjectBuilder.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.AbstractJPQLQueryBuilder.buildStateObjectBuilder.

Creates the builder that creates the StateObject for each Expression.

Returns:EclipseLinkStateObjectBuilder

The builder that will be visiting the Expression

Annotations
@Override
buildStateObjectBuilderback to summary
public IConditionalExpressionStateObjectBuilder buildStateObjectBuilder(AbstractConditionalClauseStateObject stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

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:AbstractConditionalClauseStateObject

The clause for which a conditional expression can be created

Returns:IConditionalExpressionStateObjectBuilder

The builder of a conditional expression

Annotations
@Override
buildStateObjectBuilderback to summary
public EclipseLinkSelectExpressionStateObjectBuilder buildStateObjectBuilder(SelectClauseStateObject stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

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:SelectClauseStateObject

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

Returns:EclipseLinkSelectExpressionStateObjectBuilder

The builder of a conditional expression

Annotations
@Override
buildStateObjectBuilderback to summary
public EclipseLinkSimpleSelectExpressionStateObjectBuilder buildStateObjectBuilder(SimpleSelectClauseStateObject stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

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:SimpleSelectClauseStateObject

The clause for which a select expression can be created

Returns:EclipseLinkSimpleSelectExpressionStateObjectBuilder

The builder of a conditional expression

Annotations
@Override
buildStateObjectBuilderback to summary
public INewValueStateObjectBuilder buildStateObjectBuilder(UpdateItemStateObject stateObject)

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObjectBuilder.

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:UpdateItemStateObject

The parent for which a new value expression can be created

Returns:INewValueStateObjectBuilder

The builder of a new value expression

Annotations
@Override
getGrammarback to summary
public JPQLGrammar getGrammar()

Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.getGrammar.

Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.getGrammar.

Returns the JPQLGrammar that is associated with this builder.

Returns:JPQLGrammar

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

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override