Module org.eclipse.persistence.jpa.jpql

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

Interface ISelectExpressionStateObjectBuilder

All Superinterfaces:

IScalarExpressionStateObjectBuilder<ISelectExpressionStateObjectBuilder>

All Known Subinterfaces:

IEclipseLinkSelectExpressionStateObjectBuilder

All Known Implementing Classes:

AbstractEclipseLinkSelectExpressionStateObjectBuilder, AbstractSelectExpressionStateObjectBuilder, DefaultSelectExpressionStateObjectBuilder, EclipseLinkSelectExpressionStateObjectBuilder

public interface ISelectExpressionStateObjectBuilder
extends IScalarExpressionStateObjectBuilder<ISelectExpressionStateObjectBuilder>

This builder can be used to easily create a select expression without having to create each object manually. The builder is associated with SelectClauseStateObject.

Since:

2.4

Version:

2.4

Method Summary

Modifier and Type	Method	Description
ISelectExpressionStateObjectBuilder	append()	Appends the previously created select item and starts a new stack to create a new select item.
void	commit()	Pushes the changes created by this builder to the state object.
ISelectExpressionStateObjectBuilder	new_(String className, ISelectExpressionStateObjectBuilder... parameters)	Creates the expression NEW constructor_name(identification_variable).
ISelectExpressionStateObjectBuilder	object(String identificationVariable)	Creates the expression OBJECT(identification_variable).
ISelectExpressionStateObjectBuilder	resultVariable(String resultVariable)	Defines the current state object with the given result variable.
ISelectExpressionStateObjectBuilder	resultVariableAs(String resultVariable)	Defines the current state object with the given result variable.
ISelectExpressionStateObjectBuilder	variable(String variable)	Creates the expression representing an identification variable.

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.IScalarExpressionStateObjectBuilder

abs, add, avg, avgDistinct, case_, coalesce, coalesce, concat, concat, count, countDistinct, currentDate, currentTime, currentTimestamp, date, divide, entityType, enumLiteral, function, function, function, getCaseBuilder, index, length, locate, locate, max, maxDistinct, min, minDistinct, minus, mod, multiply, nullIf, numeric, numeric, parameter, path, plus, size, sqrt, string, sub, subtract, sum, sumDistinct, type

Method Details

append

ISelectExpressionStateObjectBuilder append()

Appends the previously created select item and starts a new stack to create a new select item.

Returns:

This builder

commit

void commit()

Pushes the changes created by this builder to the state object.

new_

ISelectExpressionStateObjectBuilder new_(String className,
 ISelectExpressionStateObjectBuilder... parameters)

Creates the expression NEW constructor_name(identification_variable).

Parameters:

className - The fully qualified class name

parameters - The parameters of the constructor

Returns:

This builder

object

ISelectExpressionStateObjectBuilder object(String identificationVariable)

Creates the expression OBJECT(identification_variable).

Parameters:

identificationVariable - The identification variable

Returns:

This builder

resultVariable

ISelectExpressionStateObjectBuilder resultVariable(String resultVariable)

Defines the current state object with the given result variable.

Parameters:

resultVariable - The variable identifying the current select expression

Returns:

This builder

resultVariableAs

ISelectExpressionStateObjectBuilder resultVariableAs(String resultVariable)

Defines the current state object with the given result variable.

Parameters:

resultVariable - The variable identifying the current select expression

Returns:

This builder

variable

ISelectExpressionStateObjectBuilder variable(String variable)

Creates the expression representing an identification variable.

Parameters:

variable - The identification variable

Returns:

This builder