• Home
• org.hibernate
• hibernate-core
• 5.3.13.Final
• source code
• QueryParameterBindingsImpl.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.hibernate.query.internal.QueryParameterBindingsImpl Maven / Gradle / Ivy

/*
 * 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 .
 */
package org.hibernate.query.internal;

import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.stream.Collectors;
import javax.persistence.Parameter;

import org.hibernate.HibernateException;
import org.hibernate.Incubating;
import org.hibernate.QueryException;
import org.hibernate.QueryParameterException;
import org.hibernate.dialect.Dialect;
import org.hibernate.engine.jdbc.spi.JdbcServices;
import org.hibernate.engine.query.spi.NamedParameterDescriptor;
import org.hibernate.engine.query.spi.OrdinalParameterDescriptor;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.engine.spi.TypedValue;
import org.hibernate.internal.CoreLogging;
import org.hibernate.internal.CoreMessageLogger;
import org.hibernate.internal.util.MathHelper;
import org.hibernate.internal.util.StringHelper;
import org.hibernate.internal.util.collections.ArrayHelper;
import org.hibernate.internal.util.collections.CollectionHelper;
import org.hibernate.query.ParameterMetadata;
import org.hibernate.query.QueryParameter;
import org.hibernate.query.spi.QueryParameterBinding;
import org.hibernate.query.spi.QueryParameterBindings;
import org.hibernate.query.spi.QueryParameterListBinding;
import org.hibernate.type.SerializableType;
import org.hibernate.type.Type;

/**
 * Manages the group of QueryParameterBinding for a particular query.
 *
 * @author Steve Ebersole
 * @author Chris Cranford
 */
@Incubating
public class QueryParameterBindingsImpl implements QueryParameterBindings {
	private static final CoreMessageLogger log = CoreLogging.messageLogger( QueryParameterBindingsImpl.class );

	private final SessionFactoryImplementor sessionFactory;
	private final ParameterMetadata parameterMetadata;
	private final boolean queryParametersValidationEnabled;

	private final int ordinalParamValueOffset;

	private final int jdbcStyleOrdinalCountBase;

	private Map parameterBindingMap;
	private Map parameterListBindingMap;
	private Set parametersConvertedToListBindings;

	public static QueryParameterBindingsImpl from(
			ParameterMetadata parameterMetadata,
			SessionFactoryImplementor sessionFactory,
			boolean queryParametersValidationEnabled) {
		if ( parameterMetadata == null ) {
			throw new QueryParameterException( "Query parameter metadata cannot be null" );
		}

		return new QueryParameterBindingsImpl(
				sessionFactory,
				parameterMetadata,
				queryParametersValidationEnabled
		);
	}

	private QueryParameterBindingsImpl(
			SessionFactoryImplementor sessionFactory,
			ParameterMetadata parameterMetadata,
			boolean queryParametersValidationEnabled) {
		this.sessionFactory = sessionFactory;
		this.parameterMetadata = parameterMetadata;
		this.queryParametersValidationEnabled = queryParametersValidationEnabled;

		this.parameterBindingMap = CollectionHelper.concurrentMap( parameterMetadata.getParameterCount() );

		this.jdbcStyleOrdinalCountBase = sessionFactory.getSessionFactoryOptions().jdbcStyleParamsZeroBased() ? 0 : 1;

		if ( parameterMetadata.hasPositionalParameters() ) {
			int smallestOrdinalParamLabel = Integer.MAX_VALUE;
			for ( QueryParameter queryParameter : parameterMetadata.getPositionalParameters() ) {
				if ( queryParameter.getPosition() == null ) {
					throw new HibernateException( "Non-ordinal parameter ended up in ordinal param list" );
				}

				if ( queryParameter.getPosition() < smallestOrdinalParamLabel ) {
					smallestOrdinalParamLabel = queryParameter.getPosition();
				}
			}
			ordinalParamValueOffset = smallestOrdinalParamLabel;
		}
		else {
			ordinalParamValueOffset = 0;
		}
	}

	@SuppressWarnings("WeakerAccess")
	protected QueryParameterBinding makeBinding(QueryParameter queryParameter) {
		assert ! parameterBindingMap.containsKey( queryParameter );

		if ( ! parameterMetadata.containsReference( queryParameter ) ) {
			throw new IllegalArgumentException(
					"Cannot create binding for parameter reference [" + queryParameter + "] - reference is not a parameter of this query"
			);
		}

		final QueryParameterBinding binding = makeBinding( queryParameter.getHibernateType() );
		parameterBindingMap.put( queryParameter, binding );

		return binding;
	}

	@SuppressWarnings("WeakerAccess")
	protected QueryParameterBinding makeBinding(Type bindType) {
		return new QueryParameterBindingImpl( bindType, sessionFactory, shouldValidateBindingValue() );
	}

	@SuppressWarnings({"unchecked", "WeakerAccess"})
	protected  QueryParameterListBinding makeListBinding(QueryParameter param) {
		if ( parametersConvertedToListBindings == null ) {
			parametersConvertedToListBindings = new HashSet<>();
		}

		parametersConvertedToListBindings.add( param );

		if ( parameterListBindingMap == null ) {
			parameterListBindingMap = new HashMap<>();
		}

		return parameterListBindingMap.computeIfAbsent(
				param,
				p -> new QueryParameterListBindingImpl(
						param.getHibernateType(),
						shouldValidateBindingValue()
				)
		);
	}

	@Override
	@SuppressWarnings( "unchecked" )
	public boolean isBound(QueryParameter parameter) {
		final QueryParameterBinding binding = getBinding( parameter );

		return binding.isBound();
	}

	@SuppressWarnings("unchecked")
	public  QueryParameterBinding getBinding(QueryParameter parameter) {
		QueryParameterBinding binding = parameterBindingMap.get( parameter );

		if ( binding == null ) {
			if ( ! parameterMetadata.containsReference( parameter ) ) {
				throw new IllegalArgumentException(
						"Could not resolve QueryParameter reference [" + parameter + "] to QueryParameterBinding"
				);
			}

			binding = makeBinding( parameter );
		}

		return binding;
	}

	@Override
	@SuppressWarnings("unchecked")
	public QueryParameterBinding getBinding(int position) {
		return getBinding( parameterMetadata.getQueryParameter( position ) );
	}

	@Override
	@SuppressWarnings("unchecked")
	public QueryParameterBinding getBinding(String name) {
		return getBinding( parameterMetadata.getQueryParameter( name ) );
	}

	public void verifyParametersBound(boolean reserveFirstParameter) {
		for ( QueryParameter parameter : parameterMetadata.collectAllParameters() ) {
			// check the "normal" bindings
			if ( parameterBindingMap.containsKey( parameter ) ) {
				continue;
			}

			// next check the "list" bindings
			if ( parameterListBindingMap != null
					&& parameterListBindingMap.containsKey( parameter ) ) {
				continue;
			}

			if ( parametersConvertedToListBindings != null
					&& parametersConvertedToListBindings.contains( parameter ) ) {
				continue;
			}

			if ( parameter.getName() != null ) {
				throw new QueryException( "Named parameter not bound : " + parameter.getName() );
			}
			else {
				throw new QueryException( "Ordinal parameter not bound : " + parameter.getPosition() );
			}
		}
	}

	/**
	 * @deprecated (since 5.2) expect a different approach to org.hibernate.engine.spi.QueryParameters in 6.0
	 */
	@Deprecated
	public Collection collectBindTypes() {
		return parameterBindingMap.values()
				.stream()
				.map( QueryParameterBinding::getBindType )
				.collect( Collectors.toList() );
	}

	/**
	 * @deprecated (since 5.2) expect a different approach to org.hibernate.engine.spi.QueryParameters in 6.0
	 */
	@Deprecated
	public Collection