/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.param;

import java.sql.PreparedStatement;
import java.sql.SQLException;

import org.hibernate.engine.spi.QueryParameters;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.engine.spi.TypedValue;

Parameter bind specification for an explicit  positional (or ordinal) parameter.
Author:
Steve Ebersole/**
 * Parameter bind specification for an explicit  positional (or ordinal) parameter.
 *
 * @author Steve Ebersole
 */
public class PositionalParameterSpecification extends AbstractExplicitParameterSpecification  {
	private final int label;
	private final int bindingPosition;

	
Constructs a position/ordinal parameter bind specification.
Params:
sourceLine – See AbstractExplicitParameterSpecification.getSourceLine()
sourceColumn – See AbstractExplicitParameterSpecification.getSourceColumn()
label – The position in the source query, relative to the other source positional parameters./**
	 * Constructs a position/ordinal parameter bind specification.
	 *
	 * @param sourceLine See {@link #getSourceLine()}
	 * @param sourceColumn See {@link #getSourceColumn()}
	 * @param label The position in the source query, relative to the other source positional parameters.
	 */
	public PositionalParameterSpecification(
			int sourceLine,
			int sourceColumn,
			int label,
			int bindingPosition) {
		super( sourceLine, sourceColumn );
		this.label = label;
		this.bindingPosition = bindingPosition;
	}

	
Bind the appropriate value into the given statement at the specified position.
Params:
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./**
	 * Bind the appropriate value into the given statement at the specified position.
	 *
	 * @param statement The statement into which the value should be bound.
	 * @param qp The defined values for the current query execution.
	 * @param session The session against which the current execution is occuring.
	 * @param position The position from which to start binding value(s).
	 *
	 * @return The number of sql bind positions "eaten" by this bind operation.
	 */
	@Override
	public int bind(PreparedStatement statement, QueryParameters qp, SharedSessionContractImplementor session, int position) throws SQLException {
		final TypedValue typedValue = qp.getNamedParameters().get( Integer.toString( label ) );
		typedValue.getType().nullSafeSet( statement, typedValue.getValue(), position, session );
		return typedValue.getType().getColumnSpan( session.getFactory() );
	}

	@Override
	public String renderDisplayInfo() {
		return "label=" + label + ", expectedType=" + getExpectedType();
	}

	public int getLabel() {
		return label;
	}
}