Skip to content

Commit baa0ea9

Browse files
xhaggixhaggi
committed
Add native support for range field types by using a range object
1 parent e4c6455 commit baa0ea9

10 files changed

+987
-16
lines changed

‎src/main/java/org/springframework/data/elasticsearch/core/Range.java

+438
Large diffs are not rendered by default.

‎src/main/java/org/springframework/data/elasticsearch/core/convert/AbstractRangePersistentPropertyConverter.java

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/*
2+
* Copyright 2019-2021 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.core.convert;
17+
18+
import java.util.LinkedHashMap;
19+
import java.util.Map;
20+
21+
import org.springframework.data.elasticsearch.core.Range;
22+
import org.springframework.data.mapping.PersistentProperty;
23+
24+
/**
25+
* @author Sascha Woo
26+
* @since 4.3
27+
*/
28+
public abstract class AbstractRangePersistentPropertyConverter<T> extends AbstractPersistentPropertyConverter {
29+
30+
public AbstractRangePersistentPropertyConverter(PersistentProperty<?> property) {
31+
super(property);
32+
}
33+
34+
@Override
35+
public Object read(Object value) {
36+
37+
try {
38+
Map<String, Object> source = (LinkedHashMap) value;
39+
Range.Bound<T> lowerBound;
40+
Range.Bound<T> upperBound;
41+
42+
if (source.containsKey("lte")) {
43+
lowerBound = Range.Bound.inclusive(parse((String) source.get("lte")));
44+
} else if (source.containsKey("lt")) {
45+
lowerBound = Range.Bound.exclusive(parse((String) source.get("lt")));
46+
} else {
47+
lowerBound = Range.Bound.unbounded();
48+
}
49+
50+
if (source.containsKey("gte")) {
51+
upperBound = Range.Bound.inclusive(parse((String) source.get("gte")));
52+
} else if (source.containsKey("gt")) {
53+
upperBound = Range.Bound.exclusive(parse((String) source.get("gt")));
54+
} else {
55+
upperBound = Range.Bound.unbounded();
56+
}
57+
58+
return Range.of(lowerBound, upperBound);
59+
60+
} catch (Exception e) {
61+
throw new ConversionException(
62+
String.format("Unable to convert value '%s' of property '%s'", value, getProperty().getName()), e);
63+
}
64+
}
65+
66+
@Override
67+
public Object write(Object value) {
68+
69+
try {
70+
Range<T> range = (Range<T>) value;
71+
Range.Bound<T> lowerBound = range.getLowerBound();
72+
Range.Bound<T> upperBound = range.getUpperBound();
73+
Map<String, Object> target = new LinkedHashMap<>();
74+
75+
if (lowerBound.isBounded()) {
76+
String lowerBoundValue = format(lowerBound.getValue().get());
77+
if (lowerBound.isInclusive()) {
78+
target.put("lte", lowerBoundValue);
79+
} else {
80+
target.put("lt", lowerBoundValue);
81+
}
82+
}
83+
84+
if (upperBound.isBounded()) {
85+
String upperBoundValue = format(upperBound.getValue().get());
86+
if (upperBound.isInclusive()) {
87+
target.put("gte", upperBoundValue);
88+
} else {
89+
target.put("gt", upperBoundValue);
90+
}
91+
}
92+
93+
return target;
94+
95+
} catch (Exception e) {
96+
throw new ConversionException(
97+
String.format("Unable to convert value '%s' of property '%s'", value, getProperty().getName()), e);
98+
}
99+
}
100+
101+
protected abstract String format(T value);
102+
103+
protected abstract T parse(String value);
104+
105+
}

‎src/main/java/org/springframework/data/elasticsearch/core/convert/DateRangePersistentPropertyConverter.java

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
/*
2+
* Copyright 2019-2021 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.core.convert;
17+
18+
import java.util.Date;
19+
import java.util.List;
20+
21+
import org.slf4j.Logger;
22+
import org.slf4j.LoggerFactory;
23+
import org.springframework.data.mapping.PersistentProperty;
24+
25+
/**
26+
* @author Sascha Woo
27+
* @since 4.3
28+
*/
29+
public class DateRangePersistentPropertyConverter extends AbstractRangePersistentPropertyConverter<Date> {
30+
31+
private static final Logger LOGGER = LoggerFactory.getLogger(DateRangePersistentPropertyConverter.class);
32+
33+
private final List<ElasticsearchDateConverter> dateConverters;
34+
35+
public DateRangePersistentPropertyConverter(PersistentProperty<?> property,
36+
List<ElasticsearchDateConverter> dateConverters) {
37+
38+
super(property);
39+
this.dateConverters = dateConverters;
40+
}
41+
42+
@Override
43+
protected String format(Date value) {
44+
return dateConverters.get(0).format(value);
45+
}
46+
47+
@Override
48+
protected Date parse(String value) {
49+
50+
for (ElasticsearchDateConverter converters : dateConverters) {
51+
try {
52+
return converters.parse(value);
53+
} catch (Exception e) {
54+
LOGGER.trace(e.getMessage(), e);
55+
}
56+
}
57+
58+
throw new ConversionException(String.format("Unable to convert value '%s' to %s for property '%s'", value,
59+
getGenericType().getTypeName(), getProperty().getName()));
60+
}
61+
62+
}

‎src/main/java/org/springframework/data/elasticsearch/core/convert/MappingElasticsearchConverter.java

+1-4
Original file line numberDiff line numberDiff line change
@@ -482,10 +482,7 @@ private Object propertyConverterRead(ElasticsearchPersistentProperty property, O
482482
}
483483

484484
private Object convertOnRead(ElasticsearchPersistentPropertyConverter propertyConverter, Object source) {
485-
if (String.class.isAssignableFrom(source.getClass())) {
486-
source = propertyConverter.read((String) source);
487-
}
488-
return source;
485+
return propertyConverter.read(source);
489486
}
490487

491488
/**

‎src/main/java/org/springframework/data/elasticsearch/core/convert/NumberRangePersistentPropertyConverter.java

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/*
2+
* Copyright 2019-2021 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.core.convert;
17+
18+
import org.springframework.data.mapping.PersistentProperty;
19+
20+
/**
21+
* @author Sascha Woo
22+
* @since 4.3
23+
*/
24+
public class NumberRangePersistentPropertyConverter extends AbstractRangePersistentPropertyConverter<Number> {
25+
26+
public NumberRangePersistentPropertyConverter(PersistentProperty<?> property) {
27+
super(property);
28+
}
29+
30+
@Override
31+
protected String format(Number number) {
32+
return String.valueOf(number);
33+
}
34+
35+
@Override
36+
protected Number parse(String value) {
37+
38+
Class<?> type = getGenericType();
39+
if (Integer.class.isAssignableFrom(type)) {
40+
return Integer.valueOf(value);
41+
} else if (Float.class.isAssignableFrom(type)) {
42+
return Float.valueOf(value);
43+
} else if (Long.class.isAssignableFrom(type)) {
44+
return Long.valueOf(value);
45+
} else if (Double.class.isAssignableFrom(type)) {
46+
return Double.valueOf(value);
47+
}
48+
49+
throw new ConversionException(String.format("Unable to convert value '%s' to %s for property '%s'", value,
50+
type.getTypeName(), getProperty().getName()));
51+
}
52+
53+
}

‎src/main/java/org/springframework/data/elasticsearch/core/convert/TemporalRangePersistentPropertyConverter.java

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
/*
2+
* Copyright 2019-2021 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.core.convert;
17+
18+
import java.time.temporal.TemporalAccessor;
19+
import java.util.List;
20+
21+
import org.slf4j.Logger;
22+
import org.slf4j.LoggerFactory;
23+
import org.springframework.data.mapping.PersistentProperty;
24+
import org.springframework.util.Assert;
25+
26+
/**
27+
* @author Sascha Woo
28+
* @since 4.3
29+
*/
30+
public class TemporalRangePersistentPropertyConverter
31+
extends AbstractRangePersistentPropertyConverter<TemporalAccessor> {
32+
33+
private static final Logger LOGGER = LoggerFactory.getLogger(TemporalRangePersistentPropertyConverter.class);
34+
35+
private final List<ElasticsearchDateConverter> dateConverters;
36+
37+
public TemporalRangePersistentPropertyConverter(PersistentProperty<?> property,
38+
List<ElasticsearchDateConverter> dateConverters) {
39+
40+
super(property);
41+
42+
Assert.notEmpty(dateConverters, "dateConverters must not be empty.");
43+
this.dateConverters = dateConverters;
44+
}
45+
46+
@Override
47+
protected String format(TemporalAccessor temporal) {
48+
return dateConverters.get(0).format(temporal);
49+
}
50+
51+
@Override
52+
protected TemporalAccessor parse(String value) {
53+
54+
Class<?> type = getGenericType();
55+
for (ElasticsearchDateConverter converters : dateConverters) {
56+
try {
57+
return converters.parse(value, (Class<? extends TemporalAccessor>) type);
58+
} catch (Exception e) {
59+
LOGGER.trace(e.getMessage(), e);
60+
}
61+
}
62+
63+
throw new ConversionException(String.format("Unable to convert value '%s' to %s for property '%s'", value,
64+
type.getTypeName(), getProperty().getName()));
65+
}
66+
67+
}

‎src/main/java/org/springframework/data/elasticsearch/core/mapping/ElasticsearchPersistentPropertyConverter.java

+10-9
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,26 @@
1616
package org.springframework.data.elasticsearch.core.mapping;
1717

1818
/**
19-
* Interface defining methods to convert a property value to a String and back.
19+
* Interface defining methods to convert a persistent property value to an elasticsearch property value and back.
2020
*
2121
* @author Peter-Josef Meisch
22+
* @author Sascha Woo
2223
*/
2324
public interface ElasticsearchPersistentPropertyConverter {
2425

2526
/**
26-
* converts the property value to a String.
27+
* Converts a persistent property value to an elasticsearch property value.
2728
*
28-
* @param property the property value to convert, must not be {@literal null}
29-
* @return String representation.
29+
* @param value the persistent property value to convert, must not be {@literal null}
30+
* @return The elasticsearch property value.
3031
*/
31-
String write(Object property);
32+
Object write(Object value);
3233

3334
/**
34-
* converts a property value from a String.
35+
* Converts an elasticsearch property value to a persistent property value.
3536
*
36-
* @param s the property to convert, must not be {@literal null}
37-
* @return property value
37+
* @param value the elasticsearch property value to convert, must not be {@literal null}
38+
* @return The persistent property value.
3839
*/
39-
Object read(String s);
40+
Object read(Object value);
4041
}

0 commit comments

Comments
 (0)