Skip to content

CriteriaQuery must support nested queries. #1757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2021
Merged

CriteriaQuery must support nested queries. #1757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/main/java/org/springframework/data/elasticsearch/core/CriteriaQueryProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.List;

import org.apache.lucene.queryparser.flexible.standard.QueryParserUtil;
import org.apache.lucene.search.join.ScoreMode;
import org.elasticsearch.index.query.BoolQueryBuilder;
import org.elasticsearch.index.query.QueryBuilder;
import org.springframework.data.elasticsearch.annotations.FieldType;
Expand Down Expand Up @@ -136,7 +137,7 @@ private QueryBuilder queryForEntries(Criteria criteria) {
return null;

String fieldName = field.getName();
Assert.notNull(fieldName, "Unknown field");
Assert.notNull(fieldName, "Unknown field " + fieldName);

Iterator<Criteria.CriteriaEntry> it = criteria.getQueryCriteriaEntries().iterator();
QueryBuilder query;
Expand All @@ -152,6 +153,14 @@ private QueryBuilder queryForEntries(Criteria criteria) {
}

addBoost(query, criteria.getBoost());

int dotPosition = fieldName.lastIndexOf('.');

if (dotPosition > 0) {
String nestedPath = fieldName.substring(0, dotPosition);
query = nestedQuery(nestedPath, query, ScoreMode.Avg);
}

return query;
}

Expand Down
118 changes: 80 additions & 38 deletions ...va/org/springframework/data/elasticsearch/core/convert/MappingElasticsearchConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,15 @@ public void afterPropertiesSet() {
@SuppressWarnings("unchecked")
@Override
public <R> R read(Class<R> type, Document source) {

TypeInformation<R> typeHint = ClassTypeInformation.from((Class<R>) ClassUtils.getUserClass(type));
return read(typeHint, source);
R r = read(typeHint, source);

if (r == null) {
throw new ConversionException("could not convert into object of class " + type);
}

return r;
}

protected <R> R readEntity(ElasticsearchPersistentEntity<?> entity, Map<String, Object> source) {
Expand All @@ -188,7 +195,7 @@ protected <R> R readEntity(ElasticsearchPersistentEntity<?> entity, Map<String,

EntityInstantiator instantiator = instantiators.getInstantiatorFor(targetEntity);

@SuppressWarnings({ "unchecked", "ConstantConditions" })
@SuppressWarnings({ "unchecked" })
R instance = (R) instantiator.createInstance(targetEntity, propertyValueProvider);

if (!targetEntity.requiresPropertyPopulation()) {
Expand Down Expand Up @@ -246,6 +253,7 @@ private ParameterValueProvider<ElasticsearchPersistentProperty> getParameterProv
ElasticsearchPropertyValueProvider provider = new ElasticsearchPropertyValueProvider(source, evaluator);

// TODO: Support for non-static inner classes via ObjectPath
// noinspection ConstantConditions
PersistentEntityParameterValueProvider<ElasticsearchPersistentProperty> parameterProvider = new PersistentEntityParameterValueProvider<>(
entity, provider, null);

Expand Down Expand Up @@ -281,7 +289,6 @@ protected <R> R readProperties(ElasticsearchPersistentEntity<?> entity, R instan
return accessor.getBean();
}

@SuppressWarnings("unchecked")
@Nullable
protected <R> R readValue(@Nullable Object value, ElasticsearchPersistentProperty property, TypeInformation<?> type) {

Expand Down Expand Up @@ -349,7 +356,7 @@ private <R> R read(TypeInformation<R> type, Map<String, Object> source) {
}

if (typeToUse.isMap()) {
return (R) readMap(typeToUse, source);
return readMap(typeToUse, source);
}

if (typeToUse.equals(ClassTypeInformation.OBJECT)) {
Expand Down Expand Up @@ -549,7 +556,7 @@ public void write(Object source, Document sink) {
}

Class<?> entityType = ClassUtils.getUserClass(source.getClass());
TypeInformation<? extends Object> typeInformation = ClassTypeInformation.from(entityType);
TypeInformation<?> typeInformation = ClassTypeInformation.from(entityType);

if (requiresTypeHint(entityType)) {
typeMapper.writeType(typeInformation, sink);
Expand All @@ -561,9 +568,9 @@ public void write(Object source, Document sink) {
/**
* Internal write conversion method which should be used for nested invocations.
*
* @param source
* @param sink
* @param typeInformation
* @param source the object to write
* @param sink the write destination
* @param typeInformation type information for the source
*/
@SuppressWarnings("unchecked")
protected void writeInternal(@Nullable Object source, Map<String, Object> sink,
Expand All @@ -578,7 +585,10 @@ protected void writeInternal(@Nullable Object source, Map<String, Object> sink,

if (customTarget.isPresent()) {
Map<String, Object> result = conversionService.convert(source, Map.class);
sink.putAll(result);

if (result != null) {
sink.putAll(result);
}
return;
}

Expand All @@ -600,9 +610,9 @@ protected void writeInternal(@Nullable Object source, Map<String, Object> sink,
/**
* Internal write conversion method which should be used for nested invocations.
*
* @param source
* @param sink
* @param entity
* @param source the object to write
* @param sink the write destination
* @param entity entity for the source
*/
protected void writeInternal(@Nullable Object source, Map<String, Object> sink,
@Nullable ElasticsearchPersistentEntity<?> entity) {
Expand Down Expand Up @@ -734,7 +744,6 @@ protected void writeProperty(ElasticsearchPersistentProperty property, Object va
*
* @param collection must not be {@literal null}.
* @param property must not be {@literal null}.
* @return
*/
protected List<Object> createCollection(Collection<?> collection, ElasticsearchPersistentProperty property) {
return writeCollectionInternal(collection, property.getTypeInformation(), new ArrayList<>(collection.size()));
Expand All @@ -745,7 +754,6 @@ protected List<Object> createCollection(Collection<?> collection, ElasticsearchP
*
* @param map must not {@literal null}.
* @param property must not be {@literal null}.
* @return
*/
protected Map<String, Object> createMap(Map<?, ?> map, ElasticsearchPersistentProperty property) {

Expand All @@ -761,7 +769,6 @@ protected Map<String, Object> createMap(Map<?, ?> map, ElasticsearchPersistentPr
* @param source must not be {@literal null}.
* @param sink must not be {@literal null}.
* @param propertyType must not be {@literal null}.
* @return
*/
protected Map<String, Object> writeMapInternal(Map<?, ?> source, Map<String, Object> sink,
TypeInformation<?> propertyType) {
Expand Down Expand Up @@ -801,7 +808,6 @@ protected Map<String, Object> writeMapInternal(Map<?, ?> source, Map<String, Obj
* @param source the collection to create a {@link Collection} for, must not be {@literal null}.
* @param type the {@link TypeInformation} to consider or {@literal null} if unknown.
* @param sink the {@link Collection} to write to.
* @return
*/
@SuppressWarnings("unchecked")
private List<Object> writeCollectionInternal(Collection<?> source, @Nullable TypeInformation<?> type,
Expand Down Expand Up @@ -837,26 +843,30 @@ private List<Object> writeCollectionInternal(Collection<?> source, @Nullable Typ
/**
* Returns a {@link String} representation of the given {@link Map} key
*
* @param key
* @return
* @param key the key to convert
*/
private String potentiallyConvertMapKey(Object key) {

if (key instanceof String) {
return (String) key;
}

return conversions.hasCustomWriteTarget(key.getClass(), String.class)
? (String) getPotentiallyConvertedSimpleWrite(key, Object.class)
: key.toString();
if (conversions.hasCustomWriteTarget(key.getClass(), String.class)) {
Object potentiallyConvertedSimpleWrite = getPotentiallyConvertedSimpleWrite(key, Object.class);

if (potentiallyConvertedSimpleWrite == null) {
return key.toString();
}
return (String) potentiallyConvertedSimpleWrite;
}
return key.toString();
}

/**
* Checks whether we have a custom conversion registered for the given value into an arbitrary simple Elasticsearch
* type. Returns the converted value if so. If not, we perform special enum handling or simply return the value as is.
*
* @param value
* @return
* @param value value to convert
*/
@Nullable
private Object getPotentiallyConvertedSimpleWrite(@Nullable Object value, @Nullable Class<?> typeHint) {
Expand All @@ -869,6 +879,10 @@ private Object getPotentiallyConvertedSimpleWrite(@Nullable Object value, @Nulla

if (conversionService.canConvert(value.getClass(), typeHint)) {
value = conversionService.convert(value, typeHint);

if (value == null) {
return null;
}
}
}

Expand Down Expand Up @@ -908,8 +922,8 @@ protected Object getWriteSimpleValue(Object value) {
* @deprecated since 4.2, use {@link #writeInternal(Object, Map, TypeInformation)} instead.
*/
@Deprecated
protected Object getWriteComplexValue(ElasticsearchPersistentProperty property, TypeInformation<?> typeHint,
Object value) {
protected Object getWriteComplexValue(ElasticsearchPersistentProperty property,
@SuppressWarnings("unused") TypeInformation<?> typeHint, Object value) {

Document document = Document.create();
writeInternal(value, document, property.getTypeInformation());
Expand All @@ -928,11 +942,19 @@ protected Object getWriteComplexValue(ElasticsearchPersistentProperty property,
*
* @param source must not be {@literal null}.
* @param sink must not be {@literal null}.
* @param type
* @param type type to compare to
*/
protected void addCustomTypeKeyIfNecessary(Object source, Map<String, Object> sink, @Nullable TypeInformation<?> type) {
protected void addCustomTypeKeyIfNecessary(Object source, Map<String, Object> sink,
@Nullable TypeInformation<?> type) {

Class<?> reference = type != null ? type.getActualType().getType() : Object.class;
Class<?> reference;

if (type == null) {
reference = Object.class;
} else {
TypeInformation<?> actualType = type.getActualType();
reference = actualType == null ? Object.class : actualType.getType();
}
Class<?> valueType = ClassUtils.getUserClass(source.getClass());

boolean notTheSameClass = !valueType.equals(reference);
Expand Down Expand Up @@ -987,8 +1009,7 @@ private boolean isSimpleType(Class<?> type) {
* {@link Collection} already, will convert an array into a {@link Collection} or simply create a single element
* collection for everything else.
*
* @param source
* @return
* @param source object to convert
*/
private static Collection<?> asCollection(Object source) {

Expand Down Expand Up @@ -1019,21 +1040,42 @@ public void updateCriteriaQuery(CriteriaQuery criteriaQuery, Class<?> domainClas
}

private void updateCriteria(Criteria criteria, ElasticsearchPersistentEntity<?> persistentEntity) {

Field field = criteria.getField();

if (field == null) {
return;
}

String name = field.getName();
ElasticsearchPersistentProperty property = persistentEntity.getPersistentProperty(name);
String[] fieldNames = field.getName().split("\\.");
ElasticsearchPersistentEntity<?> currentEntity = persistentEntity;
ElasticsearchPersistentProperty persistentProperty = null;
for (int i = 0; i < fieldNames.length; i++) {
persistentProperty = currentEntity.getPersistentProperty(fieldNames[i]);

if (persistentProperty != null) {
fieldNames[i] = persistentProperty.getFieldName();
try {
currentEntity = mappingContext.getPersistentEntity(persistentProperty.getActualType());
} catch (Exception e) {
// using system types like UUIDs will lead to java.lang.reflect.InaccessibleObjectException in JDK 16
// so if we cannot get an entity here, bail out.
currentEntity = null;
}
}

if (currentEntity == null) {
break;
}
}

field.setName(String.join(".", fieldNames));

if (property != null && property.getName().equals(name)) {
field.setName(property.getFieldName());
if (persistentProperty != null) {

if (property.hasPropertyConverter()) {
if (persistentProperty.hasPropertyConverter()) {
ElasticsearchPersistentPropertyConverter propertyConverter = Objects
.requireNonNull(property.getPropertyConverter());
.requireNonNull(persistentProperty.getPropertyConverter());
criteria.getQueryCriteriaEntries().forEach(criteriaEntry -> {
Object value = criteriaEntry.getValue();
if (value.getClass().isArray()) {
Expand All @@ -1047,14 +1089,15 @@ private void updateCriteria(Criteria criteria, ElasticsearchPersistentEntity<?>
});
}

org.springframework.data.elasticsearch.annotations.Field fieldAnnotation = property
org.springframework.data.elasticsearch.annotations.Field fieldAnnotation = persistentProperty
.findAnnotation(org.springframework.data.elasticsearch.annotations.Field.class);

if (fieldAnnotation != null) {
field.setFieldType(fieldAnnotation.type());
}
}
}

// endregion

static class MapValueAccessor {
Expand Down Expand Up @@ -1148,7 +1191,6 @@ class ElasticsearchPropertyValueProvider implements PropertyValueProvider<Elasti
this.evaluator = evaluator;
}

@SuppressWarnings("unchecked")
@Override
public <T> T getPropertyValue(ElasticsearchPersistentProperty property) {

Expand Down
Loading