org.hibernate.param

Interface ParameterSpecification

Known Subinterfaces:
ExplicitParameterSpecification
Known Implementing Classes:
AbstractExplicitParameterSpecification, CollectionFilterKeyParameterSpecification, DynamicFilterParameterSpecification, NamedParameterSpecification, PositionalParameterSpecification, VersionTypeSeedParameterSpecification

public interface ParameterSpecification

Maintains information relating to parameters which need to get bound into a JDBC PreparedStatement.
Author:
Steve Ebersole

Method Summary

int
bind(PreparedStatement statement, QueryParameters qp, SessionImplementor session, int position)
Bind the appropriate value into the given statement at the specified position.
Type
getExpectedType()
Get the type which we are expeting for a bind into this parameter based on translated contextual information.
String
renderDisplayInfo()
Render this parameter into displayable info (for logging, etc).
void
setExpectedType(Type expectedType)
Injects the expected type.

Method Details

bind

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 - The statement into which the value should be bound.
qp - The defined values for the current query execution.
session - The session against which the current execution is occuring.
position - The position from which to start binding value(s).
Returns:
The number of sql bind positions "eaten" by this bind operation.

getExpectedType

public Type getExpectedType()
Get the type which we are expeting for a bind into this parameter based on translated contextual information.
Returns:
The expected type.

renderDisplayInfo

public String renderDisplayInfo()
Render this parameter into displayable info (for logging, etc).
Returns:
The displayable info.

setExpectedType

public void setExpectedType(Type expectedType)
Injects the expected type. Called during translation.
Parameters:
expectedType - The type to expect.