EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jpa.jpql.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 query.SelectClauseStateObject SelectClauseStateObject.

Version:
2.4
Author:
Pascal Filion
Since:
2.4

Method Summary
 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_(java.lang.String className, ISelectExpressionStateObjectBuilder... parameters)
          Creates the expression NEW constructor_name(identification_variable).
 ISelectExpressionStateObjectBuilder object(java.lang.String identificationVariable)
          Creates the expression OBJECT(identification_variable).
 ISelectExpressionStateObjectBuilder resultVariable(java.lang.String resultVariable)
          Defines the current state object with the given result variable.
 ISelectExpressionStateObjectBuilder resultVariableAs(java.lang.String resultVariable)
          Defines the current state object with the given result variable.
 ISelectExpressionStateObjectBuilder variable(java.lang.String variable)
          Creates the expression representing an identification variable.
 
Methods inherited from interface org.eclipse.persistence.jpa.jpql.model.IScalarExpressionStateObjectBuilder
abs, add, avg, avgDistinct, case_, coalesce, concat, count, countDistinct, currentDate, currentTime, currentTimestamp, date, divide, entityType, enumLiteral, 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 Detail

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_(java.lang.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(java.lang.String identificationVariable)
Creates the expression OBJECT(identification_variable).

Parameters:
identificationVariable - The identification variable
Returns:
This builder

resultVariable

ISelectExpressionStateObjectBuilder resultVariable(java.lang.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(java.lang.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(java.lang.String variable)
Creates the expression representing an identification variable.

Parameters:
variable - The identification variable
Returns:
This builder

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference