Top Description Methods
org.hibernate.param

public Interface ParameterSpecification

Known Direct Subinterfaces
org.hibernate.param.ExplicitParameterSpecification
Known Direct Implementers
org.hibernate.param.PositionalParameterSpecification, org.hibernate.param.VersionTypeSeedParameterSpecification, org.hibernate.hql.ast.tree.IndexNode.AggregatedIndexCollectionSelectorParameterSpecifications, org.hibernate.param.CollectionFilterKeyParameterSpecification, org.hibernate.param.DynamicFilterParameterSpecification, org.hibernate.param.NamedParameterSpecification
Imports
org.hibernate.engine.QueryParameters, .SessionImplementor, org.hibernate.type.Type, java.sql.PreparedStatement, .SQLException
Maintains information relating to parameters which need to get bound into a JDBC PreparedStatement.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The number of sql bind positions "eaten" by this bind operation.
bind(PreparedStatement
The statement into which the value should be bound.
statement, QueryParameters
The defined values for the current query execution.
qp, SessionImplementor
The session against which the current execution is occuring.
session, int
The position from which to start binding value(s).
position)

Bind the appropriate value into the given statement at the specified position.

public Type

Returns:

The expected type.
getExpectedType()

Get the type which we are expeting for a bind into this parameter based on translated contextual information.

public String

Returns:

The displayable info.
renderDisplayInfo()

Render this parameter into displayable info (for logging, etc).

public void
setExpectedType(Type
The type to expect.
expectedType)

Injects the expected type.

Method Detail

bindback to summary
public int bind(PreparedStatement statement, QueryParameters qp, SessionImplementor session, int position) throws SQLException

Bind the appropriate value into the given statement at the specified position.

Parameters
statement:PreparedStatement

The statement into which the value should be bound.

qp:QueryParameters

The defined values for the current query execution.

session:SessionImplementor

The session against which the current execution is occuring.

position:int

The position from which to start binding value(s).

Returns:int

The number of sql bind positions "eaten" by this bind operation.

Exceptions
SQLException:
Indicates problems performing the JDBC biind operation.
getExpectedTypeback to summary
public Type getExpectedType()

Get the type which we are expeting for a bind into this parameter based on translated contextual information.

Returns:Type

The expected type.

renderDisplayInfoback to summary
public String renderDisplayInfo()

Render this parameter into displayable info (for logging, etc).

Returns:String

The displayable info.

setExpectedTypeback to summary
public void setExpectedType(Type expectedType)

Injects the expected type. Called during translation.

Parameters
expectedType:Type

The type to expect.