Package org.hibernate.sql.exec.internal

Class AbstractJdbcParameter

java.lang.Object

org.hibernate.sql.exec.internal.AbstractJdbcParameter

All Implemented Interfaces:

BasicValuedMapping, Bindable, JdbcMappingContainer, MappingModelExpressible, SqlExpressible, ValueMapping, SqlSelectionProducer, Expression, JdbcParameter, SqlAstNode, JdbcParameterBinder, JavaTypedExpressible

Direct Known Subclasses:

ColumnValueParameter, JdbcParameterImpl, SqlTypedMappingJdbcParameter, VersionTypeSeedParameterSpecification

public abstract class AbstractJdbcParameter
extends Object
implements JdbcParameter, JdbcParameterBinder, MappingModelExpressible, SqlExpressible, BasicValuedMapping

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
AbstractJdbcParameter(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	bindParameterValue(PreparedStatement statement, int startPosition, JdbcParameterBindings jdbcParamBindings, ExecutionContext executionContext)	Bind the appropriate value in the JDBC statement
protected void	bindParameterValue(JdbcMapping jdbcMapping, PreparedStatement statement, Object bindValue, int startPosition, ExecutionContext executionContext)
SqlSelection	createSqlSelection(int jdbcPosition, int valuesArrayPosition, JavaType javaType, TypeConfiguration typeConfiguration)	Create a SqlSelection for the given JDBC ResultSet position
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.
MappingModelExpressible	getExpressionType()	The type for this expression
JdbcMapping	getJdbcMapping()	Anything that is expressible at the SQL AST level would be of basic type.
int	getJdbcTypeCount()	The number of JDBC mappings
MappingType	getMappedType()	Descriptor for the type of this mapping
JdbcParameterBinder	getParameterBinder()
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.BasicValuedMapping

getJdbcMapping

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, createDomainResultSqlSelection, createSqlSelection, getColumnReference

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

getExpressibleJavaType, treatAs

Constructor Detail

AbstractJdbcParameter

public AbstractJdbcParameter(JdbcMapping jdbcMapping)

Method Detail

getParameterBinder

public JdbcParameterBinder getParameterBinder()

Specified by:

getParameterBinder in interface JdbcParameter

getJdbcMapping

public JdbcMapping getJdbcMapping()

Description copied from interface: SqlExpressible

Anything that is expressible at the SQL AST level would be of basic type.

Specified by:

getJdbcMapping in interface BasicValuedMapping

Specified by:

getJdbcMapping in interface SqlExpressible

getMappedType

public MappingType getMappedType()

Description copied from interface: ValueMapping

Descriptor for the type of this mapping

Specified by:

getMappedType in interface ValueMapping

accept

public void accept(SqlAstWalker sqlTreeWalker)

Specified by:

accept in interface SqlAstNode

createSqlSelection

public SqlSelection createSqlSelection(int jdbcPosition,
                                       int valuesArrayPosition,
                                       JavaType javaType,
                                       TypeConfiguration typeConfiguration)

Description copied from interface: SqlSelectionProducer

Create a SqlSelection for the given JDBC ResultSet position

Specified by:

createSqlSelection in interface Expression

Specified by:

createSqlSelection in interface SqlSelectionProducer

Parameters:

jdbcPosition - The index position used to read values from JDBC

valuesArrayPosition - The position in our "current JDBC values array"

javaType - The descriptor for the Java type to read the value as

typeConfiguration - The associated TypeConfiguration

getSingleJdbcMapping

public JdbcMapping getSingleJdbcMapping()

Specified by:

getSingleJdbcMapping in interface BasicValuedMapping

Specified by:

getSingleJdbcMapping in interface JdbcMappingContainer

bindParameterValue

public void bindParameterValue(PreparedStatement statement,
                               int startPosition,
                               JdbcParameterBindings jdbcParamBindings,
                               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

bindParameterValue

protected void bindParameterValue(JdbcMapping jdbcMapping,
                                  PreparedStatement statement,
                                  Object bindValue,
                                  int startPosition,
                                  ExecutionContext executionContext)
                           throws SQLException

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 BasicValuedMapping

Specified by:

getJdbcTypeCount in interface Bindable

Specified by:

getJdbcTypeCount 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 BasicValuedMapping

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 BasicValuedMapping

Specified by:

addToCacheKey in interface Bindable

Specified by:

addToCacheKey in interface JavaTypedExpressible

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