|
| 1 | +/* |
| 2 | + * Copyright 2023 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package org.springframework.data.elasticsearch.repository.support.querybyexample; |
| 17 | + |
| 18 | +import org.springframework.dao.InvalidDataAccessApiUsageException; |
| 19 | +import org.springframework.data.domain.Example; |
| 20 | +import org.springframework.data.domain.ExampleMatcher; |
| 21 | +import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity; |
| 22 | +import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentProperty; |
| 23 | +import org.springframework.data.elasticsearch.core.query.Criteria; |
| 24 | +import org.springframework.data.mapping.PersistentPropertyAccessor; |
| 25 | +import org.springframework.data.mapping.context.MappingContext; |
| 26 | +import org.springframework.data.support.ExampleMatcherAccessor; |
| 27 | +import org.springframework.lang.Nullable; |
| 28 | +import org.springframework.util.StringUtils; |
| 29 | + |
| 30 | +import java.util.EnumSet; |
| 31 | +import java.util.Map; |
| 32 | +import java.util.Optional; |
| 33 | +import java.util.Set; |
| 34 | + |
| 35 | +/** |
| 36 | + * Maps a {@link Example} to a {@link org.springframework.data.elasticsearch.core.query.Criteria} |
| 37 | + * |
| 38 | + * @param <T> Class type |
| 39 | + * @author Ezequiel Antúnez Camacho |
| 40 | + */ |
| 41 | +class ExampleCriteriaMapper<T> { |
| 42 | + |
| 43 | + private static final Set<ExampleMatcher.StringMatcher> SUPPORTED_MATCHERS = EnumSet.of( |
| 44 | + ExampleMatcher.StringMatcher.DEFAULT, ExampleMatcher.StringMatcher.EXACT, ExampleMatcher.StringMatcher.STARTING, |
| 45 | + ExampleMatcher.StringMatcher.CONTAINING, ExampleMatcher.StringMatcher.ENDING); |
| 46 | + |
| 47 | + private final MappingContext<? extends ElasticsearchPersistentEntity<T>, ElasticsearchPersistentProperty> mappingContext; |
| 48 | + |
| 49 | + /** |
| 50 | + * Builds a {@link ExampleCriteriaMapper} |
| 51 | + * |
| 52 | + * @param mappingContext mappingContext to use |
| 53 | + */ |
| 54 | + ExampleCriteriaMapper( |
| 55 | + MappingContext<? extends ElasticsearchPersistentEntity<T>, ElasticsearchPersistentProperty> mappingContext) { |
| 56 | + this.mappingContext = mappingContext; |
| 57 | + } |
| 58 | + |
| 59 | + <S extends T> Criteria criteria(Example<S> example) { |
| 60 | + return buildCriteria(example); |
| 61 | + } |
| 62 | + |
| 63 | + private <S extends T> Criteria buildCriteria(Example<S> example) { |
| 64 | + final ExampleMatcherAccessor matcherAccessor = new ExampleMatcherAccessor(example.getMatcher()); |
| 65 | + |
| 66 | + return applyPropertySpecs(new Criteria(), "", example.getProbe(), |
| 67 | + mappingContext.getRequiredPersistentEntity(example.getProbeType()), matcherAccessor, |
| 68 | + example.getMatcher().getMatchMode()); |
| 69 | + } |
| 70 | + |
| 71 | + private Criteria applyPropertySpecs(Criteria criteria, String path, @Nullable Object probe, |
| 72 | + ElasticsearchPersistentEntity<?> persistentEntity, ExampleMatcherAccessor exampleSpecAccessor, |
| 73 | + ExampleMatcher.MatchMode matchMode) { |
| 74 | + |
| 75 | + if (probe == null) { |
| 76 | + return criteria; |
| 77 | + } |
| 78 | + |
| 79 | + PersistentPropertyAccessor<?> propertyAccessor = persistentEntity.getPropertyAccessor(probe); |
| 80 | + |
| 81 | + for (ElasticsearchPersistentProperty property : persistentEntity) { |
| 82 | + final String propertyName = getPropertyName(property); |
| 83 | + String propertyPath = StringUtils.hasText(path) ? (path + "." + propertyName) : propertyName; |
| 84 | + if (exampleSpecAccessor.isIgnoredPath(propertyPath) || property.isCollectionLike() |
| 85 | + || property.isVersionProperty()) { |
| 86 | + continue; |
| 87 | + } |
| 88 | + |
| 89 | + Object propertyValue = propertyAccessor.getProperty(property); |
| 90 | + if (property.isMap() && propertyValue != null) { |
| 91 | + for (Map.Entry<String, Object> entry : ((Map<String, Object>) propertyValue).entrySet()) { |
| 92 | + String key = entry.getKey(); |
| 93 | + Object value = entry.getValue(); |
| 94 | + criteria = applyPropertySpec(propertyPath + "." + key, value, exampleSpecAccessor, property, matchMode, |
| 95 | + criteria); |
| 96 | + } |
| 97 | + continue; |
| 98 | + } |
| 99 | + |
| 100 | + criteria = applyPropertySpec(propertyPath, propertyValue, exampleSpecAccessor, property, matchMode, criteria); |
| 101 | + } |
| 102 | + return criteria; |
| 103 | + } |
| 104 | + |
| 105 | + private String getPropertyName(ElasticsearchPersistentProperty property) { |
| 106 | + return property.isIdProperty() ? "_id" : property.getName(); |
| 107 | + } |
| 108 | + |
| 109 | + private Criteria applyPropertySpec(String path, Object propertyValue, ExampleMatcherAccessor exampleSpecAccessor, |
| 110 | + ElasticsearchPersistentProperty property, ExampleMatcher.MatchMode matchMode, Criteria criteria) { |
| 111 | + |
| 112 | + if (exampleSpecAccessor.isIgnoreCaseForPath(path)) { |
| 113 | + throw new InvalidDataAccessApiUsageException( |
| 114 | + "Current implementation of Query-by-Example supports only case-sensitive matching."); |
| 115 | + } |
| 116 | + |
| 117 | + ExampleMatcher.StringMatcher stringMatcher = exampleSpecAccessor.getStringMatcherForPath(path); |
| 118 | + if (!SUPPORTED_MATCHERS.contains(exampleSpecAccessor.getStringMatcherForPath(path))) { |
| 119 | + throw new InvalidDataAccessApiUsageException(String.format( |
| 120 | + "Current implementation of Query-by-Example does not support string matcher %s. Supported matchers are: %s.", |
| 121 | + stringMatcher, SUPPORTED_MATCHERS)); |
| 122 | + } |
| 123 | + |
| 124 | + final Object transformedValue = exampleSpecAccessor.getValueTransformerForPath(path) |
| 125 | + .apply(Optional.ofNullable(propertyValue)).orElse(null); |
| 126 | + |
| 127 | + if (transformedValue == null) { |
| 128 | + criteria = tryToAppendMustNotSentence(criteria, path, exampleSpecAccessor); |
| 129 | + } else { |
| 130 | + if (property.isEntity()) { |
| 131 | + return applyPropertySpecs(criteria, path, transformedValue, |
| 132 | + mappingContext.getRequiredPersistentEntity(property), exampleSpecAccessor, matchMode); |
| 133 | + } else { |
| 134 | + return applyStringMatcher(applyMatchMode(criteria, path, matchMode), transformedValue, stringMatcher); |
| 135 | + } |
| 136 | + } |
| 137 | + return criteria; |
| 138 | + } |
| 139 | + |
| 140 | + private Criteria tryToAppendMustNotSentence(Criteria criteria, String path, |
| 141 | + ExampleMatcherAccessor exampleSpecAccessor) { |
| 142 | + if (ExampleMatcher.NullHandler.INCLUDE.equals(exampleSpecAccessor.getNullHandler()) |
| 143 | + || exampleSpecAccessor.hasPropertySpecifier(path)) { |
| 144 | + return criteria.and(path).not().exists(); |
| 145 | + } |
| 146 | + return criteria; |
| 147 | + } |
| 148 | + |
| 149 | + private Criteria applyMatchMode(Criteria criteria, String path, ExampleMatcher.MatchMode matchMode) { |
| 150 | + if (matchMode == ExampleMatcher.MatchMode.ALL) { |
| 151 | + return criteria.and(path); |
| 152 | + } else { |
| 153 | + return criteria.or(path); |
| 154 | + } |
| 155 | + } |
| 156 | + |
| 157 | + private Criteria applyStringMatcher(Criteria criteria, Object value, ExampleMatcher.StringMatcher stringMatcher) { |
| 158 | + return switch (stringMatcher) { |
| 159 | + case DEFAULT, EXACT -> criteria.is(value); |
| 160 | + case STARTING -> criteria.startsWith(validateString(value)); |
| 161 | + case ENDING -> criteria.endsWith(validateString(value)); |
| 162 | + case CONTAINING -> criteria.contains(validateString(value)); |
| 163 | + case REGEX -> throw new UnsupportedOperationException("REGEX matcher is unsupported"); |
| 164 | + }; |
| 165 | + } |
| 166 | + |
| 167 | + private String validateString(Object value) { |
| 168 | + if (value instanceof String) { |
| 169 | + return value.toString(); |
| 170 | + } |
| 171 | + throw new IllegalArgumentException("This operation requires a String but got " + value.getClass()); |
| 172 | + } |
| 173 | + |
| 174 | +} |
0 commit comments