fixup! Allow multiple date formats for date fields

Author: xhaggi

src/main/asciidoc/reference/elasticsearch-object-mapping.adoc

@@ -64,8 +64,7 @@ See https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-type
 * `@GeoPoint`: marks a field as _geo_point_ datatype.
 Can be omitted if the field is an instance of the `GeoPoint` class.
 
-NOTE: Properties that derive from `TemporalAccessor` or are of type `java.util.Date` must either have a `@Field` annotation of type `FieldType.Date` and a
-format different from `DateFormat.none` or a custom converter must be registered for this type. +
+NOTE: Properties that derive from `TemporalAccessor` or are of type `java.util.Date` must either have a `@Field` annotation of type `FieldType.Date`.
 If you are using a custom date format, you need to use _uuuu_ for the year instead of _yyyy_.
 This is due to a https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-to-java-time.html#java-time-migration-incompatible-date-formats[change in Elasticsearch 7].
 

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

@@ -27,7 +27,7 @@
  */
 public enum DateFormat {
 	/**
-	 * @deprecated will be removed in a future version
+	 * @deprecated since 4.2, will be removed in a future version, use multiple formats in the @Field annotation.
 	 */
 	@Deprecated
 	none(""), //

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

@@ -68,7 +68,7 @@
 
 	DateFormat[] format() default { DateFormat.date_optional_time, DateFormat.epoch_millis };
 
-	String pattern() default "";
+	String[] pattern() default {};
 
 	boolean store() default false;
 

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

@@ -42,7 +42,7 @@
 
 	DateFormat[] format() default { DateFormat.date_optional_time, DateFormat.epoch_millis };
 
-	String pattern() default "";
+	String[] pattern() default {};
 
 	boolean store() default false;
 

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

@@ -81,12 +81,12 @@ public final class MappingParameters {
 	private final String analyzer;
 	private final boolean coerce;
 	@Nullable private final String[] copyTo;
-	private final String datePattern;
+	private final DateFormat[] dateFormats;
+	private final String[] dateFormatPatterns;
 	private final boolean docValues;
 	private final boolean eagerGlobalOrdinals;
 	private final boolean enabled;
 	private final boolean fielddata;
-	private final DateFormat[] format;
 	@Nullable private final Integer ignoreAbove;
 	private final boolean ignoreMalformed;
 	private final boolean index;
@@ -132,8 +132,8 @@ private MappingParameters(Field field) {
 		store = field.store();
 		fielddata = field.fielddata();
 		type = field.type();
-		format = field.format();
-		datePattern = field.pattern();
+		dateFormats = field.format();
+		dateFormatPatterns = field.pattern();
 		analyzer = field.analyzer();
 		searchAnalyzer = field.searchAnalyzer();
 		normalizer = field.normalizer();
@@ -174,8 +174,8 @@ private MappingParameters(InnerField field) {
 		store = field.store();
 		fielddata = field.fielddata();
 		type = field.type();
-		format = field.format();
-		datePattern = field.pattern();
+		dateFormats = field.format();
+		dateFormatPatterns = field.pattern();
 		analyzer = field.analyzer();
 		searchAnalyzer = field.searchAnalyzer();
 		normalizer = field.normalizer();
@@ -229,16 +229,21 @@ public void writeTypeAndParametersTo(XContentBuilder builder) throws IOException
 
 		if (type != FieldType.Auto) {
 			builder.field(FIELD_PARAM_TYPE, type.name().toLowerCase());
-			if (type == FieldType.Date && format.length > 0) {
+
+			if (type == FieldType.Date && dateFormats.length > 0) {
 				List<String> formats = new ArrayList<>();
-				for (int i = 0; i < format.length; i++) {
-					DateFormat dateFormat = format[i];
+
+				for (int i = 0; i < dateFormats.length; i++) {
+					DateFormat dateFormat = dateFormats[i];
 					if (dateFormat == DateFormat.custom) {
-						formats.add(datePattern);
+						for (int ii = 0; ii < dateFormatPatterns.length; ii++) {
+							formats.add(dateFormatPatterns[ii]);
+						}
 					} else {
 						formats.add(dateFormat.toString());
 					}
 				}
+
 				builder.field(FIELD_PARAM_FORMAT, String.join("||", formats));
 			}
 		}

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

@@ -161,7 +161,7 @@ private void initDateConverter() {
 
 			if (dateFormats.length == 0) {
 				LOGGER.warn(
-						String.format("No DateFormat defined for property %s. Make sure you have a Converter registered for %s",
+						String.format("Property %s is annotated with FieldType.%s but has no format defined. Make sure you have a converter registered for %s.",
 								property, actualType.getSimpleName()));
 				return;
 			}
@@ -172,23 +172,30 @@ private void initDateConverter() {
 				DateFormat dateFormat = dateFormats[i];
 
 				if (dateFormat == DateFormat.custom) {
-					String pattern = field.pattern();
+					String[] dateFormatPatterns = field.pattern();
 
-					if (!StringUtils.hasLength(pattern)) {
+					if (dateFormatPatterns.length == 0) {
 						throw new MappingException(String.format(
-								"Property %s is annotated with FieldType.%s and a custom format but has no pattern defined", property,
+								"Property %s is annotated with FieldType.%s and a custom format but has no pattern defined.", property,
 								field.type().name()));
 					}
 
-					converters.add(ElasticsearchDateConverter.of(pattern));
+					for (int j = 0; j < dateFormatPatterns.length; j++) {
+						String pattern = dateFormatPatterns[j];
+						if (!StringUtils.hasText(pattern)) {
+							throw new MappingException(
+									String.format("Date pattern of property %s must not be empty", property, field.type().name()));
+						}
+						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");
+							LOGGER.warn("No default converter available for " + actualType.getName() + " and date format "
+									+ dateFormat.name() + ". Use a custom converter instead.");
 							break;
 						default:
 							converters.add(ElasticsearchDateConverter.of(dateFormat));

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

@@ -23,7 +23,6 @@
 /**
  * @author Peter-Josef Meisch
  * @author Tim te Beek
- * @author Sascha Woo
  */
 class ElasticsearchDateConverterUnitTests {