/*
* Copyright 2008-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.repository.query;
import javax.persistence.Query;
import org.springframework.data.jpa.repository.query.QueryParameterSetter.ErrorHandling;
import org.springframework.util.Assert;
ParameterBinder
is used to bind method parameters to a Query
. This is usually done whenever an AbstractJpaQuery
is executed. Author: Oliver Gierke, Thomas Darimont, Mark Paluch, Christoph Strobl, Jens Schauder
/**
* {@link ParameterBinder} is used to bind method parameters to a {@link Query}. This is usually done whenever an
* {@link AbstractJpaQuery} is executed.
*
* @author Oliver Gierke
* @author Thomas Darimont
* @author Mark Paluch
* @author Christoph Strobl
* @author Jens Schauder
*/
public class ParameterBinder {
static final String PARAMETER_NEEDS_TO_BE_NAMED = "For queries with named parameters you need to use provide names for method parameters. Use @Param for query method parameters, or when on Java 8+ use the javac flag -parameters.";
private final JpaParameters parameters;
private final Iterable<QueryParameterSetter> parameterSetters;
private final boolean useJpaForPaging;
Creates a new ParameterBinder
for the given JpaParameters
and QueryParameterSetter
s. Defaults to use JPA API to apply pagination offsets. Params: - parameters – must not be null.
- parameterSetters – must not be null.
Since: 2.0.6
/**
* Creates a new {@link ParameterBinder} for the given {@link JpaParameters} and {@link QueryParameterSetter}s.
* Defaults to use JPA API to apply pagination offsets.
*
* @param parameters must not be {@literal null}.
* @param parameterSetters must not be {@literal null}.
* @since 2.0.6
*/
ParameterBinder(JpaParameters parameters, Iterable<QueryParameterSetter> parameterSetters) {
this(parameters, parameterSetters, true);
}
Params: - parameters – must not be null.
- parameterSetters – must not be null.
- useJpaForPaging – determines whether
Query.setFirstResult(int)
and Query.setMaxResults(int)
shall be used for paging.
/**
* Creates a new {@link ParameterBinder} for the given {@link JpaParameters} and {@link QueryParameterSetter}s.
*
* @param parameters must not be {@literal null}.
* @param parameterSetters must not be {@literal null}.
* @param useJpaForPaging determines whether {@link Query#setFirstResult(int)} and {@link Query#setMaxResults(int)}
* shall be used for paging.
*/
public ParameterBinder(JpaParameters parameters, Iterable<QueryParameterSetter> parameterSetters,
boolean useJpaForPaging) {
Assert.notNull(parameters, "JpaParameters must not be null!");
Assert.notNull(parameterSetters, "Parameter setters must not be null!");
this.parameters = parameters;
this.parameterSetters = parameterSetters;
this.useJpaForPaging = useJpaForPaging;
}
public <T extends Query> T bind(T jpaQuery, QueryParameterSetter.QueryMetadata metadata,
JpaParametersParameterAccessor accessor) {
bind(metadata.withQuery(jpaQuery), accessor, ErrorHandling.STRICT);
return jpaQuery;
}
public void bind(QueryParameterSetter.BindableQuery query, JpaParametersParameterAccessor accessor,
ErrorHandling errorHandling) {
for (QueryParameterSetter setter : parameterSetters) {
setter.setParameter(query, accessor, errorHandling);
}
}
Binds the parameters to the given query and applies special parameter types (e.g. pagination).
Params: - query – must not be null.
- values – values of method parameters to be assigned to the query parameters.
/**
* Binds the parameters to the given query and applies special parameter types (e.g. pagination).
*
* @param query must not be {@literal null}.
* @param values values of method parameters to be assigned to the query parameters.
*/
Query bindAndPrepare(Query query, QueryParameterSetter.QueryMetadata metadata,
JpaParametersParameterAccessor accessor) {
bind(query, metadata, accessor);
if (!useJpaForPaging || !parameters.hasPageableParameter() || accessor.getPageable().isUnpaged()) {
return query;
}
query.setFirstResult((int) accessor.getPageable().getOffset());
query.setMaxResults(accessor.getPageable().getPageSize());
return query;
}
}