Allow multiple date formats for date fields

Author: xhaggi

src/main/java/org/springframework/data/elasticsearch/annotations/DateFormat.java

@@ -23,9 +23,9 @@
  * @author Jakub Vavrik
  * @author Tim te Beek
  * @author Peter-Josef Meisch
+ * @author Sascha Woo
  */
 public enum DateFormat {
-	none(""), //
 	custom(""), //
 	basic_date("uuuuMMdd"), //
 	basic_date_time("uuuuMMdd'T'HHmmss.SSSXXX"), //

src/main/java/org/springframework/data/elasticsearch/annotations/Field.java

@@ -36,6 +36,7 @@
  * @author Aleksei Arsenev
  * @author Brian Kimmig
  * @author Morgan Lutz
+ * @author Sascha Woo
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@@ -65,7 +66,7 @@
 
 	boolean index() default true;
 
-	DateFormat format() default DateFormat.none;
+	DateFormat[] format() default { DateFormat.date_optional_time, DateFormat.epoch_millis };
 
 	String pattern() default "";
 

src/main/java/org/springframework/data/elasticsearch/annotations/InnerField.java

@@ -40,7 +40,7 @@
 
 	boolean index() default true;
 
-	DateFormat format() default DateFormat.none;
+	DateFormat[] format() default { DateFormat.date_optional_time, DateFormat.epoch_millis };
 
 	String pattern() default "";
 

src/main/java/org/springframework/data/elasticsearch/core/index/MappingParameters.java

@@ -17,6 +17,8 @@
 
 import java.io.IOException;
 import java.lang.annotation.Annotation;
+import java.util.ArrayList;
+import java.util.List;
 
 import org.elasticsearch.common.Nullable;
 import org.elasticsearch.common.xcontent.XContentBuilder;
@@ -41,6 +43,7 @@
  * @author Aleksei Arsenev
  * @author Brian Kimmig
  * @author Morgan Lutz
+ * @author Sascha Woo
  * @since 4.0
  */
 public final class MappingParameters {
@@ -83,7 +86,7 @@ public final class MappingParameters {
 	private final boolean eagerGlobalOrdinals;
 	private final boolean enabled;
 	private final boolean fielddata;
-	private final DateFormat format;
+	private final DateFormat[] format;
 	@Nullable private final Integer ignoreAbove;
 	private final boolean ignoreMalformed;
 	private final boolean index;
@@ -226,8 +229,17 @@ public void writeTypeAndParametersTo(XContentBuilder builder) throws IOException
 
 		if (type != FieldType.Auto) {
 			builder.field(FIELD_PARAM_TYPE, type.name().toLowerCase());
-			if (type == FieldType.Date && format != DateFormat.none) {
-				builder.field(FIELD_PARAM_FORMAT, format == DateFormat.custom ? datePattern : format.toString());
+			if (type == FieldType.Date && format.length > 0) {
+				List<String> formats = new ArrayList<>();
+				for (int i = 0; i < format.length; i++) {
+					DateFormat dateFormat = format[i];
+					if (dateFormat == DateFormat.custom) {
+						formats.add(datePattern);
+					} else {
+						formats.add(format.toString());
+					}
+				}
+				builder.field(FIELD_PARAM_FORMAT, String.join("||", formats));
 			}
 		}
 

src/main/java/org/springframework/data/elasticsearch/core/mapping/SimpleElasticsearchPersistentProperty.java

@@ -154,51 +154,79 @@ private void initDateConverter() {
 
 		if (field != null && (field.type() == FieldType.Date || field.type() == FieldType.Date_Nanos)
 				&& (isTemporalAccessor || isDate)) {
-			DateFormat dateFormat = field.format();
+			DateFormat[] dateFormats = field.format();
 
 			String property = getOwner().getType().getSimpleName() + "." + getName();
 
-			if (dateFormat == DateFormat.none) {
+			if (dateFormats.length == 0) {
 				LOGGER.warn(
 						String.format("No DateFormat defined for property %s. Make sure you have a Converter registered for %s",
 								property, actualType.getSimpleName()));
 				return;
 			}
 
-			ElasticsearchDateConverter converter = null;
+			List<ElasticsearchDateConverter> converters = new ArrayList<>();
 
-			if (dateFormat == DateFormat.custom) {
-				String pattern = field.pattern();
+			for (int i = 0; i < dateFormats.length; i++) {
+				DateFormat dateFormat = dateFormats[i];
 
-				if (!StringUtils.hasLength(pattern)) {
-					throw new MappingException(
-							String.format("Property %s is annotated with FieldType.%s and a custom format but has no pattern defined",
-									property, field.type().name()));
-				}
+				if (dateFormat == DateFormat.custom) {
+					String pattern = field.pattern();
+
+					if (!StringUtils.hasLength(pattern)) {
+						throw new MappingException(String.format(
+								"Property %s is annotated with FieldType.%s and a custom format but has no pattern defined", property,
+								field.type().name()));
+					}
 
-				converter = ElasticsearchDateConverter.of(pattern);
-			} else {
-
-				switch (dateFormat) {
-					case weekyear:
-					case weekyear_week:
-					case weekyear_week_day:
-						LOGGER.warn("no Converter available for " + actualType.getName() + " and date format " + dateFormat.name()
-								+ ". Use a custom converter instead");
-						break;
-					default:
-						converter = ElasticsearchDateConverter.of(dateFormat);
-						break;
+					converters.add(ElasticsearchDateConverter.of(pattern));
+				} else {
+
+					switch (dateFormat) {
+						case weekyear:
+						case weekyear_week:
+						case weekyear_week_day:
+							LOGGER.warn("no Converter available for " + actualType.getName() + " and date format " + dateFormat.name()
+									+ ". Use a custom converter instead");
+							break;
+						default:
+							converters.add(ElasticsearchDateConverter.of(dateFormat));
+							break;
+					}
 				}
+
 			}
 
-			if (converter != null) {
-				ElasticsearchDateConverter finalConverter = converter;
+			if (!converters.isEmpty()) {
 				propertyConverter = new ElasticsearchPersistentPropertyConverter() {
-					final ElasticsearchDateConverter dateConverter = finalConverter;
+					final List<ElasticsearchDateConverter> dateConverters = converters;
+
+					@SuppressWarnings("unchecked")
+					@Override
+					public Object read(String s) {
+						if (isTemporalAccessor) {
+							for (ElasticsearchDateConverter dateConverter : dateConverters) {
+								try {
+									return dateConverter.parse(s, (Class<? extends TemporalAccessor>) actualType);
+								} catch (Exception e) {
+								}
+							}
+						} else { // must be date
+							for (ElasticsearchDateConverter dateConverter : dateConverters) {
+								try {
+									return dateConverter.parse(s);
+								} catch (Exception e) {
+								}
+							}
+						}
+
+						throw new RuntimeException(String
+								.format("Unable to parse date value '%s' of property '%s' with configured converters", s, property));
+					}
 
 					@Override
 					public String write(Object property) {
+						ElasticsearchDateConverter dateConverter = dateConverters.get(0);
 						if (isTemporalAccessor && TemporalAccessor.class.isAssignableFrom(property.getClass())) {
 							return dateConverter.format((TemporalAccessor) property);
 						} else if (isDate && Date.class.isAssignableFrom(property.getClass())) {
@@ -207,16 +235,6 @@ public String write(Object property) {
 							return property.toString();
 						}
 					}
-
-					@SuppressWarnings("unchecked")
-					@Override
-					public Object read(String s) {
-						if (isTemporalAccessor) {
-							return dateConverter.parse(s, (Class<? extends TemporalAccessor>) actualType);
-						} else { // must be date
-							return dateConverter.parse(s);
-						}
-					}
 				};
 			}
 		}

src/test/java/org/springframework/data/elasticsearch/core/convert/ElasticsearchDateConverterUnitTests.java

@@ -23,6 +23,7 @@
 /**
  * @author Peter-Josef Meisch
  * @author Tim te Beek
+ * @author Sascha Woo
  */
 class ElasticsearchDateConverterUnitTests {
 
@@ -33,7 +34,6 @@ class ElasticsearchDateConverterUnitTests {
 	void shouldCreateConvertersForAllKnownFormats(DateFormat dateFormat) {
 
 		switch (dateFormat) {
-			case none:
 			case weekyear:
 			case weekyear_week:
 			case weekyear_week_day: