All Downloads are FREE. Search and download functionalities are using the official Maven repository.
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.springframework.data.jpa.repository.query.ParameterMetadataProvider Maven / Gradle / Ivy
/*
* Copyright 2011-2021 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 java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.ParameterExpression;
import org.springframework.data.jpa.provider.PersistenceProvider;
import org.springframework.data.repository.query.Parameter;
import org.springframework.data.repository.query.Parameters;
import org.springframework.data.repository.query.ParametersParameterAccessor;
import org.springframework.data.repository.query.parser.Part;
import org.springframework.data.repository.query.parser.Part.IgnoreCaseType;
import org.springframework.data.repository.query.parser.Part.Type;
import org.springframework.expression.Expression;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.CollectionUtils;
import org.springframework.util.ObjectUtils;
/**
* Helper class to allow easy creation of {@link ParameterMetadata}s.
*
* @author Oliver Gierke
* @author Thomas Darimont
* @author Mark Paluch
* @author Christoph Strobl
* @author Jens Schauder
* @author Andrey Kovalev
*/
class ParameterMetadataProvider {
private final CriteriaBuilder builder;
private final Iterator parameters;
private final List> expressions;
private final @Nullable Iterator bindableParameterValues;
private final EscapeCharacter escape;
/**
* Creates a new {@link ParameterMetadataProvider} from the given {@link CriteriaBuilder} and
* {@link ParametersParameterAccessor}.
*
* @param builder must not be {@literal null}.
* @param accessor must not be {@literal null}.
* @param escape must not be {@literal null}.
*/
public ParameterMetadataProvider(CriteriaBuilder builder, ParametersParameterAccessor accessor,
EscapeCharacter escape) {
this(builder, accessor.iterator(), accessor.getParameters(), escape);
}
/**
* Creates a new {@link ParameterMetadataProvider} from the given {@link CriteriaBuilder} and {@link Parameters} with
* support for parameter value customizations via {@link PersistenceProvider}.
*
* @param builder must not be {@literal null}.
* @param parameters must not be {@literal null}.
* @param escape must not be {@literal null}.
*/
public ParameterMetadataProvider(CriteriaBuilder builder, Parameters parameters, EscapeCharacter escape) {
this(builder, null, parameters, escape);
}
/**
* Creates a new {@link ParameterMetadataProvider} from the given {@link CriteriaBuilder} an {@link Iterable} of all
* bindable parameter values, and {@link Parameters}.
*
* @param builder must not be {@literal null}.
* @param bindableParameterValues may be {@literal null}.
* @param parameters must not be {@literal null}.
* @param escape must not be {@literal null}.
*/
private ParameterMetadataProvider(CriteriaBuilder builder, @Nullable Iterator bindableParameterValues,
Parameters parameters, EscapeCharacter escape) {
Assert.notNull(builder, "CriteriaBuilder must not be null!");
Assert.notNull(parameters, "Parameters must not be null!");
Assert.notNull(escape, "EscapeCharacter must not be null!");
this.builder = builder;
this.parameters = parameters.getBindableParameters().iterator();
this.expressions = new ArrayList<>();
this.bindableParameterValues = bindableParameterValues;
this.escape = escape;
}
/**
* Returns all {@link ParameterMetadata}s built.
*
* @return the expressions
*/
public List> getExpressions() {
return expressions;
}
/**
* Builds a new {@link ParameterMetadata} for given {@link Part} and the next {@link Parameter}.
*/
@SuppressWarnings("unchecked")
public ParameterMetadata next(Part part) {
Assert.isTrue(parameters.hasNext(), () -> String.format("No parameter available for part %s.", part));
Parameter parameter = parameters.next();
return (ParameterMetadata) next(part, parameter.getType(), parameter);
}
/**
* Builds a new {@link ParameterMetadata} of the given {@link Part} and type. Forwards the underlying
* {@link Parameters} as well.
*
* @param is the type parameter of the returned {@link ParameterMetadata}.
* @param type must not be {@literal null}.
* @return ParameterMetadata for the next parameter.
*/
@SuppressWarnings("unchecked")
public ParameterMetadata next(Part part, Class type) {
Parameter parameter = parameters.next();
Class typeToUse = ClassUtils.isAssignable(type, parameter.getType()) ? parameter.getType() : type;
return (ParameterMetadata) next(part, typeToUse, parameter);
}
/**
* Builds a new {@link ParameterMetadata} for the given type and name.
*
* @param type parameter for the returned {@link ParameterMetadata}.
* @param part must not be {@literal null}.
* @param type must not be {@literal null}.
* @param parameter providing the name for the returned {@link ParameterMetadata}.
* @return a new {@link ParameterMetadata} for the given type and name.
*/
private ParameterMetadata next(Part part, Class type, Parameter parameter) {
Assert.notNull(type, "Type must not be null!");
/*
* We treat Expression types as Object vales since the real value to be bound as a parameter is determined at query time.
*/
@SuppressWarnings("unchecked")
Class reifiedType = Expression.class.equals(type) ? (Class) Object.class : type;
Supplier name = () -> parameter.getName()
.orElseThrow(() -> new IllegalArgumentException("o_O Parameter needs to be named"));
ParameterExpression expression = parameter.isExplicitlyNamed() //
? builder.parameter(reifiedType, name.get()) //
: builder.parameter(reifiedType);
Object value = bindableParameterValues == null ? ParameterMetadata.PLACEHOLDER : bindableParameterValues.next();
ParameterMetadata metadata = new ParameterMetadata<>(expression, part, value, escape);
expressions.add(metadata);
return metadata;
}
EscapeCharacter getEscape() {
return escape;
}
/**
* @author Oliver Gierke
* @author Thomas Darimont
* @author Andrey Kovalev
* @param
*/
static class ParameterMetadata {
static final Object PLACEHOLDER = new Object();
private final Type type;
private final ParameterExpression expression;
private final EscapeCharacter escape;
private final boolean ignoreCase;
/**
* Creates a new {@link ParameterMetadata}.
*/
public ParameterMetadata(ParameterExpression expression, Part part, @Nullable Object value,
EscapeCharacter escape) {
this.expression = expression;
this.type = value == null && Type.SIMPLE_PROPERTY.equals(part.getType()) ? Type.IS_NULL : part.getType();
this.ignoreCase = IgnoreCaseType.ALWAYS.equals(part.shouldIgnoreCase());
this.escape = escape;
}
/**
* Returns the {@link ParameterExpression}.
*
* @return the expression
*/
public ParameterExpression getExpression() {
return expression;
}
/**
* Returns whether the parameter shall be considered an {@literal IS NULL} parameter.
*/
public boolean isIsNullParameter() {
return Type.IS_NULL.equals(type);
}
/**
* Prepares the object before it's actually bound to the {@link javax.persistence.Query;}.
*
* @param value must not be {@literal null}.
*/
@Nullable
public Object prepare(Object value) {
Assert.notNull(value, "Value must not be null!");
Class expressionType = expression.getJavaType();
if (String.class.equals(expressionType)) {
switch (type) {
case STARTING_WITH:
return String.format("%s%%", escape.escape(value.toString()));
case ENDING_WITH:
return String.format("%%%s", escape.escape(value.toString()));
case CONTAINING:
case NOT_CONTAINING:
return String.format("%%%s%%", escape.escape(value.toString()));
default:
return value;
}
}
return Collection.class.isAssignableFrom(expressionType) //
? upperIfIgnoreCase(ignoreCase, toCollection(value)) //
: value;
}
/**
* Returns the given argument as {@link Collection} which means it will return it as is if it's a
* {@link Collections}, turn an array into an {@link ArrayList} or simply wrap any other value into a single element
* {@link Collections}.
*
* @param value the value to be converted to a {@link Collection}.
* @return the object itself as a {@link Collection} or a {@link Collection} constructed from the value.
*/
@Nullable
private static Collection toCollection(@Nullable Object value) {
if (value == null) {
return null;
}
if (value instanceof Collection) {
Collection collection = (Collection) value;
return collection.isEmpty() ? null : collection;
}
if (ObjectUtils.isArray(value)) {
List collection = Arrays.asList(ObjectUtils.toObjectArray(value));
return collection.isEmpty() ? null : collection;
}
return Collections.singleton(value);
}
@Nullable
@SuppressWarnings("unchecked")
private static Collection upperIfIgnoreCase(boolean ignoreCase, @Nullable Collection collection) {
if (!ignoreCase || CollectionUtils.isEmpty(collection)) {
return collection;
}
return ((Collection) collection).stream() //
.map(it -> it == null //
? null //
: it.toUpperCase()) //
.collect(Collectors.toList());
}
}
}
