org.hibernate.param
Class DynamicFilterParameterSpecification

java.lang.Object
  org.hibernate.param.DynamicFilterParameterSpecification

All Implemented Interfaces:

ParameterSpecification

public class DynamicFilterParameterSpecification
extends Object
implements ParameterSpecification

A specialized ParameterSpecification impl for dealing with a dynamic filter parameters.

Author:

Steve Ebersole

See Also:

Session.enableFilter(String)

Constructor Summary

DynamicFilterParameterSpecification(String filterName, String parameterName, Type definedParameterType)
Constructs a parameter specification for a particular filter parameter.

Method Summary

int	bind(PreparedStatement statement, QueryParameters qp, SessionImplementor session, int start) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicFilterParameterSpecification

public DynamicFilterParameterSpecification(String filterName,
                                           String parameterName,
                                           Type definedParameterType)

Constructs a parameter specification for a particular filter parameter.

Parameters:

filterName - The name of the filter

parameterName - The name of the parameter

definedParameterType - The paremeter type specified on the filter metadata

Method Detail

bind

public int bind(PreparedStatement statement,
                QueryParameters qp,
                SessionImplementor session,
                int start)
         throws SQLException

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

Specified by:

bind in interface ParameterSpecification

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.

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

Returns:

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

Throws:

SQLException - Indicates problems performing the JDBC biind operation.

getExpectedType

public Type getExpectedType()

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

Specified by:

getExpectedType in interface ParameterSpecification

Returns:

The expected type.

setExpectedType

public void setExpectedType(Type expectedType)

Injects the expected type. Called during translation.

Specified by:

setExpectedType in interface ParameterSpecification

Parameters:

expectedType - The type to expect.

renderDisplayInfo

public String renderDisplayInfo()

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

Specified by:

renderDisplayInfo in interface ParameterSpecification

Returns:

The displayable info.