-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Core: Add DateFormatter interface for java time parsing (#33467)
The existing approach used date formatters when a format based string like `date_time||epoch_millis` was used, instead of the custom code. In order to properly solve this, a new interface called `DateFormatter` has been added, which now can be implemented for custom formatters. Currently there are two implementations, one using java time and one doing the epoch_millis formatter, which simply parses a number and then converts it to a date in UTC timezone. The DateFormatter interface now also has a method to retrieve the name of the formatter pattern, which is needed for mapping changes anyway. The existing `CompoundDateTimeFormatter` class has been removed, the name was not really nice anyway. One more minor change is the fact, that the new java time using FormatDateFormatter does not try to parse the date with its printer implementation first (which might be a strict one and fail), but a printer can now be specified in addition. This saves one potential failure/exception when parsing less strict dates. If only a printer is specified, the printer will also be used as a parser.
- Loading branch information
Showing
17 changed files
with
456 additions
and
249 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
server/src/main/java/org/elasticsearch/common/time/DateFormatter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.common.time; | ||
|
|
||
| import java.time.ZoneId; | ||
| import java.time.format.DateTimeParseException; | ||
| import java.time.temporal.TemporalAccessor; | ||
| import java.time.temporal.TemporalField; | ||
| import java.util.Arrays; | ||
| import java.util.Map; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| public interface DateFormatter { | ||
|
|
||
| /** | ||
| * Try to parse input to a java time TemporalAccessor | ||
| * @param input An arbitrary string resembling the string representation of a date or time | ||
| * @throws DateTimeParseException If parsing fails, this exception will be thrown. | ||
| * Note that it can contained suppressed exceptions when several formatters failed parse this value | ||
| * @return The java time object containing the parsed input | ||
| */ | ||
| TemporalAccessor parse(String input); | ||
|
|
||
| /** | ||
| * Create a copy of this formatter that is configured to parse dates in the specified time zone | ||
| * | ||
| * @param zoneId The time zone to act on | ||
| * @return A copy of the date formatter this has been called on | ||
| */ | ||
| DateFormatter withZone(ZoneId zoneId); | ||
|
|
||
| /** | ||
| * Print the supplied java time accessor in a string based representation according to this formatter | ||
| * | ||
| * @param accessor The temporal accessor used to format | ||
| * @return The string result for the formatting | ||
| */ | ||
| String format(TemporalAccessor accessor); | ||
|
|
||
| /** | ||
| * A name based format for this formatter. Can be one of the registered formatters like <code>epoch_millis</code> or | ||
| * a configured format like <code>HH:mm:ss</code> | ||
| * | ||
| * @return The name of this formatter | ||
| */ | ||
| String pattern(); | ||
|
|
||
| /** | ||
| * Configure a formatter using default fields for a TemporalAccessor that should be used in case | ||
| * the supplied date is not having all of those fields | ||
| * | ||
| * @param fields A <code>Map<TemporalField, Long></code> of fields to be used as fallbacks | ||
| * @return A new date formatter instance, that will use those fields during parsing | ||
| */ | ||
| DateFormatter parseDefaulting(Map<TemporalField, Long> fields); | ||
|
|
||
| /** | ||
| * Merge several date formatters into a single one. Useful if you need to have several formatters with | ||
| * different formats act as one, for example when you specify a | ||
| * format like <code>date_hour||epoch_millis</code> | ||
| * | ||
| * @param formatters The list of date formatters to be merged together | ||
| * @return The new date formtter containing the specified date formatters | ||
| */ | ||
| static DateFormatter merge(DateFormatter ... formatters) { | ||
| return new MergedDateFormatter(formatters); | ||
| } | ||
|
|
||
| class MergedDateFormatter implements DateFormatter { | ||
|
|
||
| private final String format; | ||
| private final DateFormatter[] formatters; | ||
|
|
||
| MergedDateFormatter(DateFormatter ... formatters) { | ||
| this.formatters = formatters; | ||
| this.format = Arrays.stream(formatters).map(DateFormatter::pattern).collect(Collectors.joining("||")); | ||
| } | ||
|
|
||
| @Override | ||
| public TemporalAccessor parse(String input) { | ||
| DateTimeParseException failure = null; | ||
| for (DateFormatter formatter : formatters) { | ||
| try { | ||
| return formatter.parse(input); | ||
| } catch (DateTimeParseException e) { | ||
| if (failure == null) { | ||
| failure = e; | ||
| } else { | ||
| failure.addSuppressed(e); | ||
| } | ||
| } | ||
| } | ||
| throw failure; | ||
| } | ||
|
|
||
| @Override | ||
| public DateFormatter withZone(ZoneId zoneId) { | ||
| return new MergedDateFormatter(Arrays.stream(formatters).map(f -> f.withZone(zoneId)).toArray(DateFormatter[]::new)); | ||
| } | ||
|
|
||
| @Override | ||
| public String format(TemporalAccessor accessor) { | ||
| return formatters[0].format(accessor); | ||
| } | ||
|
|
||
| @Override | ||
| public String pattern() { | ||
| return format; | ||
| } | ||
|
|
||
| @Override | ||
| public DateFormatter parseDefaulting(Map<TemporalField, Long> fields) { | ||
| return new MergedDateFormatter(Arrays.stream(formatters).map(f -> f.parseDefaulting(fields)).toArray(DateFormatter[]::new)); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.