EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.model.JPQLQueryBuilderWrapper

Modifier and Type	Field and Description
private final IJPQLQueryBuilder	delegate The delegate builder that receives the calls from this one.

Access	Constructor and Description
protected	JPQLQueryBuilderWrapper(IJPQLQueryBuilder The delegate builder that receives the calls from this one delegate) Creates a new `JPQLQueryBuilderWrapper`.

Method Summary

Modifier and Type	Method and Description
public ICaseExpressionStateObjectBuilder	buildCaseExpressionStateObjectBuilder(StateObject The `StateObject` that will be the parent of the newly created model parent) Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildCaseExpressionStateObjectBuilder. Creates a builder that can create a `CASE` expression programmatically.
public JPQLQueryStateObject	buildStateObject(IManagedTypeProvider The provider of managed types provider, CharSequence The JPQL query to parse into a `StateObject` model jpqlQuery, boolean Determines if the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries tolerant) Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Creates a state model representation of a JPQL query that can be edited.
public JPQLQueryStateObject	buildStateObject(IManagedTypeProvider The provider of managed types provider, CharSequence The JPQL query to parse into a `StateObject` model jpqlQuery, String The unique identifier of the query BNF that will be used to parse the fragment queryBNFId, boolean Determines if the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries tolerant) Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Creates a state model representation of a JPQL query that can be edited.
public StateObject	buildStateObject(StateObject The `StateObject` that will be the parent of the newly created model parent, CharSequence A portion of a JPQL query that will be parsed and the `StateObject` representation will be created jpqlFragment, String The unique identifier of the query BNF that will be used to parse the fragment queryBNFId) Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Creates a `StateObject` representation of the given JPQL fragment.
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 ISelectExpressionStateObjectBuilder	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 ISimpleSelectExpressionStateObjectBuilder	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.
protected IJPQLQueryBuilder	Returns: The wrapped builder getDelegate() Returns the delegate builder that receives the calls from this one.
public JPQLGrammar	getGrammar() Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.getGrammar. Returns the `JPQLGrammar` that is associated with this builder.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

delegate	back to summary
private final IJPQLQueryBuilder delegate The delegate builder that receives the calls from this one.

JPQLQueryBuilderWrapper	back to summary
protected JPQLQueryBuilderWrapper(IJPQLQueryBuilder delegate) Creates a new `JPQLQueryBuilderWrapper`. Parameters delegate:IJPQLQueryBuilder The delegate builder that receives the calls from this one Exceptions NullPointerException: If the given delegate is `null`

Method Detail

buildCaseExpressionStateObjectBuilder back to summary

buildCaseExpressionStateObjectBuilder	back to summary
public ICaseExpressionStateObjectBuilder buildCaseExpressionStateObjectBuilder(StateObject parent) Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildCaseExpressionStateObjectBuilder. Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildCaseExpressionStateObjectBuilder. Creates a builder that can create a `CASE` expression programmatically. Once the expression is complete, `ICaseExpressionStateObjectBuilder#buildStateObject()` will return the result. Parameters parent:StateObject The `StateObject` that will be the parent of the newly created model Returns:ICaseExpressionStateObjectBuilder The builder of a `CASE` expression Annotations @Override

public ICaseExpressionStateObjectBuilder buildCaseExpressionStateObjectBuilder(StateObject parent)

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

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

Creates a builder that can create a CASE expression programmatically. Once the expression is complete, ICaseExpressionStateObjectBuilder#buildStateObject() will return the result.

Parameters

parent:StateObject: The StateObject that will be the parent of the newly created model

Returns:ICaseExpressionStateObjectBuilder

The builder of a CASE expression

Annotations

@Override

buildStateObject back to summary

buildStateObject	back to summary
public JPQLQueryStateObject buildStateObject(IManagedTypeProvider provider, CharSequence jpqlQuery, boolean tolerant) Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Creates a state model representation of a JPQL query that can be edited. Parameters provider:IManagedTypeProvider The provider of managed types jpqlQuery:CharSequence The JPQL query to parse into a `StateObject` model tolerant:boolean Determines if the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries Returns:JPQLQueryStateObject The root of the `StateObject` model that represents the edited form of the JPQL query Annotations @Override

public JPQLQueryStateObject buildStateObject(IManagedTypeProvider provider, CharSequence jpqlQuery, boolean tolerant)

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

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

Creates a state model representation of a JPQL query that can be edited.

Parameters

provider:IManagedTypeProvider: The provider of managed types
jpqlQuery:CharSequence: The JPQL query to parse into a StateObject model
tolerant:boolean: Determines if the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

Returns:JPQLQueryStateObject

The root of the StateObject model that represents the edited form of the JPQL query

Annotations

@Override

buildStateObject back to summary

buildStateObject	back to summary
public JPQLQueryStateObject buildStateObject(IManagedTypeProvider provider, CharSequence jpqlQuery, String queryBNFId, boolean tolerant) Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Creates a state model representation of a JPQL query that can be edited. Parameters provider:IManagedTypeProvider The provider of managed types jpqlQuery:CharSequence The JPQL query to parse into a `StateObject` model queryBNFId:String The unique identifier of the query BNF that will be used to parse the fragment tolerant:boolean Determines if the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries Returns:JPQLQueryStateObject The root of the `StateObject` model that represents the edited form of the JPQL query Annotations @Override

public JPQLQueryStateObject buildStateObject(IManagedTypeProvider provider, CharSequence jpqlQuery, String queryBNFId, boolean tolerant)

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

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

Creates a state model representation of a JPQL query that can be edited.

Parameters

provider:IManagedTypeProvider: The provider of managed types
jpqlQuery:CharSequence: The JPQL query to parse into a StateObject model
queryBNFId:String: The unique identifier of the query BNF that will be used to parse the fragment
tolerant:boolean: Determines if the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

Returns:JPQLQueryStateObject

The root of the StateObject model that represents the edited form of the JPQL query

Annotations

@Override

buildStateObject back to summary

buildStateObject	back to summary
public StateObject buildStateObject(StateObject parent, CharSequence jpqlFragment, String queryBNFId) Implements org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Doc from org.eclipse.persistence.jpa.jpql.tools.model.IJPQLQueryBuilder.buildStateObject. Creates a `StateObject` representation of the given JPQL fragment. In order to properly parse the fragment, the given unique identifier of the `JPQLQueryBNF` will determine how to parse it. It is possible the given JPQL fragment has more than one expression, in this case, parsing should stop at the first comma (x, y) or space (x y) where x and y are two separate expressions. Parameters parent:StateObject The `StateObject` that will be the parent of the newly created model jpqlFragment:CharSequence A portion of a JPQL query that will be parsed and the `StateObject` representation will be created queryBNFId:String The unique identifier of the query BNF that will be used to parse the fragment Returns:StateObject The `StateObject` representation of the given JPQL fragment Annotations @Override

public StateObject buildStateObject(StateObject parent, CharSequence jpqlFragment, String queryBNFId)

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

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

Creates a StateObject representation of the given JPQL fragment. In order to properly parse the fragment, the given unique identifier of the JPQLQueryBNF will determine how to parse it.

It is possible the given JPQL fragment has more than one expression, in this case, parsing should stop at the first comma (x, y) or space (x y) where x and y are two separate expressions.

Parameters

parent:StateObject: The StateObject that will be the parent of the newly created model
jpqlFragment:CharSequence: A portion of a JPQL query that will be parsed and the StateObject representation will be created
queryBNFId:String: The unique identifier of the query BNF that will be used to parse the fragment

Returns:StateObject

The StateObject representation of the given JPQL fragment

Annotations

@Override

buildStateObjectBuilder back to summary

buildStateObjectBuilder	back 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

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

buildStateObjectBuilder back to summary

buildStateObjectBuilder	back to summary
public ISelectExpressionStateObjectBuilder 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:ISelectExpressionStateObjectBuilder The builder of a conditional expression Annotations @Override

public ISelectExpressionStateObjectBuilder 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:ISelectExpressionStateObjectBuilder

The builder of a conditional expression

Annotations

@Override

buildStateObjectBuilder back to summary

buildStateObjectBuilder	back to summary
public ISimpleSelectExpressionStateObjectBuilder 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:ISimpleSelectExpressionStateObjectBuilder The builder of a conditional expression Annotations @Override

public ISimpleSelectExpressionStateObjectBuilder 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:ISimpleSelectExpressionStateObjectBuilder

The builder of a conditional expression

Annotations

@Override

buildStateObjectBuilder back to summary

buildStateObjectBuilder	back 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

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

getDelegate	back to summary
protected IJPQLQueryBuilder getDelegate() Returns the delegate builder that receives the calls from this one. Returns:IJPQLQueryBuilder The wrapped builder

getDelegate

back to summary

protected IJPQLQueryBuilder getDelegate()

Returns the delegate builder that receives the calls from this one.

Returns:IJPQLQueryBuilder: The wrapped builder

getGrammar back to summary

getGrammar	back 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

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

public abstract Class JPQLQueryBuilderWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail