Package org.hibernate.sql.ast.tree.expression

Class JdbcLiteral<T>

java.lang.Object

org.hibernate.sql.ast.tree.expression.JdbcLiteral<T>

All Implemented Interfaces:

Bindable, JdbcMappingContainer, MappingModelExpressible<T>, DomainResultProducer<T>, SqlSelectionProducer, Expression, Literal, SqlAstNode, JdbcParameterBinder, JavaTypedExpressible<T>

public class JdbcLiteral<T>
extends Object
implements Literal, MappingModelExpressible<T>, DomainResultProducer<T>, JavaTypedExpressible<T>

Represents a literal in the SQL AST. This form accepts a JdbcMapping and acts as its own MappingModelExpressible.

See Also:

QueryLiteral

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.metamodel.mapping.Bindable

Bindable.JdbcValuesBiConsumer<X,Y>, Bindable.JdbcValuesConsumer

Field Summary

Fields inherited from interface org.hibernate.sql.exec.spi.JdbcParameterBinder

NOOP

Constructor Summary

Constructors

Constructor	Description
JdbcLiteral(T literalValue, JdbcMapping jdbcMapping)

Method Summary

Modifier and Type	Method	Description
void	accept(SqlAstWalker sqlTreeWalker)
void	addToCacheKey(MutableCacheKeyBuilder cacheKey, Object value, SharedSessionContractImplementor session)	Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.
void	applySqlSelections(DomainResultCreationState creationState)	Used when this producer is a selection in a sub-query.
void	bindParameterValue(PreparedStatement statement, int startPosition, JdbcParameterBindings jdbcParameterBindings, ExecutionContext executionContext)	Bind the appropriate value in the JDBC statement
DomainResult<T>	createDomainResult(String resultVariable, DomainResultCreationState creationState)	Produce the domain query
Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
<X,Y> int	forEachDisassembledJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).
int	forEachJdbcType(int offset, IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
<X,Y> int	forEachJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Visit each constituent JDBC value extracted from the entity instance itself.
JavaType<T>	getExpressibleJavaType()
MappingModelExpressible	getExpressionType()	The type for this expression
JdbcMapping	getJdbcMapping()
JdbcMapping	getJdbcMapping(int index)
int	getJdbcTypeCount()	The number of JDBC mappings
Object	getLiteralValue()
JdbcMapping	getSingleJdbcMapping()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.metamodel.mapping.Bindable

forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

Methods inherited from interface org.hibernate.sql.ast.tree.expression.Expression

createDomainResultSqlSelection, createSqlSelection, getColumnReference

Constructor Detail

JdbcLiteral

public JdbcLiteral(T literalValue,
                   JdbcMapping jdbcMapping)

Method Detail

getLiteralValue

public Object getLiteralValue()

Specified by:

getLiteralValue in interface Literal

getJdbcMapping

public JdbcMapping getJdbcMapping()

Specified by:

getJdbcMapping in interface Literal

accept

public void accept(SqlAstWalker sqlTreeWalker)

Specified by:

accept in interface SqlAstNode

bindParameterValue

public void bindParameterValue(PreparedStatement statement,
                               int startPosition,
                               JdbcParameterBindings jdbcParameterBindings,
                               ExecutionContext executionContext)
                        throws SQLException

Description copied from interface: JdbcParameterBinder

Bind the appropriate value in the JDBC statement

Specified by:

bindParameterValue in interface JdbcParameterBinder

Throws:

SQLException

getExpressionType

public MappingModelExpressible getExpressionType()

Description copied from interface: Expression

The type for this expression

Specified by:

getExpressionType in interface Expression

getJdbcTypeCount

public int getJdbcTypeCount()

Description copied from interface: Bindable

The number of JDBC mappings

Specified by:

getJdbcTypeCount in interface Bindable

Specified by:

getJdbcTypeCount in interface JdbcMappingContainer

getJdbcMapping

public JdbcMapping getJdbcMapping(int index)

Specified by:

getJdbcMapping in interface JdbcMappingContainer

getSingleJdbcMapping

public JdbcMapping getSingleJdbcMapping()

Specified by:

getSingleJdbcMapping in interface JdbcMappingContainer

forEachJdbcType

public int forEachJdbcType(int offset,
                           IndexedConsumer<JdbcMapping> action)

Description copied from interface: JdbcMappingContainer

Visit each JdbcMapping starting from the given offset

Specified by:

forEachJdbcType in interface JdbcMappingContainer

disassemble

public Object disassemble(Object value,
                          SharedSessionContractImplementor session)

Description copied from interface: Bindable

Breaks down a value of J into its simple pieces. E.g., an embedded value gets broken down into an array of its attribute state; a basic value converts to itself; etc.

Generally speaking, this is the form in which entity state is kept relative to a Session via EntityEntry.

 @Entity class Person {
     @Id Integer id;
     @Embedded Name name;
     int age;
 }

 @Embeddable class Name {
     String familiarName;
     String familyName;
 }
 

At the top level, we would want to disassemble a Person value, so we'd ask the Bindable for the Person entity to disassemble. Given a Person value:

 Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )
 

this disassemble would result in a multidimensional array:

 [ ["Steve", "Ebersole"], 28 ]
 

Note that the identifier is not part of this disassembled state. Note also how the embedded value results in a sub-array.

Specified by:

disassemble in interface Bindable

See Also:

EntityEntry

addToCacheKey

public void addToCacheKey(MutableCacheKeyBuilder cacheKey,
                          Object value,
                          SharedSessionContractImplementor session)

Description copied from interface: Bindable

Add to the MutableCacheKey the values obtained disassembling the value and the hasCode generated from the disassembled value.

Specified by:

addToCacheKey in interface Bindable

Specified by:

addToCacheKey in interface JavaTypedExpressible<T>

Parameters:

cacheKey - the MutableCacheKey used to add the disassembled value and the hashCode

value - the value to disassemble

session - the SharedSessionContractImplementor

forEachDisassembledJdbcValue

public <X,Y> int forEachDisassembledJdbcValue(Object value,
                                                    int offset,
                                                    X x,
                                                    Y y,
                                                    Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,
                                                    SharedSessionContractImplementor session)

Description copied from interface: Bindable

Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).

Specified by:

forEachDisassembledJdbcValue in interface Bindable

forEachJdbcValue

public <X,Y> int forEachJdbcValue(Object value,
                                        int offset,
                                        X x,
                                        Y y,
                                        Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,
                                        SharedSessionContractImplementor session)

Description copied from interface: Bindable

Visit each constituent JDBC value extracted from the entity instance itself. Short-hand form of calling Bindable.disassemble(java.lang.Object, org.hibernate.engine.spi.SharedSessionContractImplementor) and piping its result to Bindable.forEachDisassembledJdbcValue(Object, int, JdbcValuesConsumer, SharedSessionContractImplementor)

Specified by:

forEachJdbcValue in interface Bindable

createDomainResult

public DomainResult<T> createDomainResult(String resultVariable,
                                          DomainResultCreationState creationState)

Description copied from interface: DomainResultProducer

Produce the domain query

Specified by:

createDomainResult in interface DomainResultProducer<T>

applySqlSelections

public void applySqlSelections(DomainResultCreationState creationState)

Description copied from interface: DomainResultProducer

Used when this producer is a selection in a sub-query. The DomainResult is only needed for root query of a SELECT statement. This default impl assumes this producer is a true (Sql)Expression

Specified by:

applySqlSelections in interface DomainResultProducer<T>

getExpressibleJavaType

public JavaType<T> getExpressibleJavaType()

Specified by:

getExpressibleJavaType in interface JavaTypedExpressible<T>