Top Description Fields Constructors Methods
org.hibernate.param

public Class NamedParameterSpecification

extends AbstractExplicitParameterSpecification
implements ParameterSpecification
Class Inheritance
All Implemented Interfaces
org.hibernate.param.ParameterSpecification
Imports
org.hibernate.engine.QueryParameters, .SessionImplementor, .TypedValue, java.sql.PreparedStatement, .SQLException
Parameter bind specification for an explicit named parameter.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final String
name

Constructor Summary

AccessConstructor and Description
public
NamedParameterSpecification(int
See getSourceLine()
sourceLine, int
See getSourceColumn()
sourceColumn, String
The named parameter name.
name)

Constructs a named parameter bind specification.

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)

Implements org.hibernate.param.ParameterSpecification.bind.

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

Returns:

Value for property 'name'.
getName()

Getter for property 'name'.

public String
renderDisplayInfo()

Implements org.hibernate.param.ParameterSpecification.renderDisplayInfo.

Render this parameter into displayable info (for logging, etc).
Inherited from org.hibernate.param.AbstractExplicitParameterSpecification:
getExpectedTypegetSourceColumngetSourceLinesetExpectedType

Field Detail

nameback to summary
private final String name

Constructor Detail

NamedParameterSpecificationback to summary
public NamedParameterSpecification(int sourceLine, int sourceColumn, String name)

Constructs a named parameter bind specification.

Parameters
sourceLine:int

See getSourceLine()

sourceColumn:int

See getSourceColumn()

name:String

The named parameter name.

Method Detail

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

Implements org.hibernate.param.ParameterSpecification.bind.

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:

Doc from org.hibernate.param.ParameterSpecification.bind.

Indicates problems performing the JDBC biind operation.

getNameback to summary
public String getName()

Getter for property 'name'.

Returns:String

Value for property 'name'.

renderDisplayInfoback to summary
public String renderDisplayInfo()

Implements org.hibernate.param.ParameterSpecification.renderDisplayInfo.

Doc from org.hibernate.param.ParameterSpecification.renderDisplayInfo.

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

Returns:String

The displayable info.