View Javadoc
1   /**
2    * This file Copyright (c) 2020 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.ui.field.converter;
35  
36  import info.magnolia.ui.field.DateFieldDefinition;
37  
38  import java.time.LocalDate;
39  import java.time.LocalDateTime;
40  import java.time.ZoneId;
41  import java.time.format.DateTimeFormatter;
42  import java.time.temporal.Temporal;
43  import java.util.Date;
44  import java.util.Locale;
45  import java.util.Optional;
46  
47  import javax.inject.Inject;
48  
49  import com.vaadin.data.Converter;
50  import com.vaadin.data.Result;
51  import com.vaadin.data.ValueContext;
52  import com.vaadin.data.converter.LocalDateTimeToDateConverter;
53  import com.vaadin.data.converter.LocalDateToDateConverter;
54  
55  /**
56   * Custom converter for DateField. Needs to handle conversion between Temporal and Date as well as String to Temporal
57   * for correct handling of default value.
58   *
59   * Converter needs access to DateFieldDefinition in order to decide which of LocalDate and LocalDateTime should be used.
60   */
61  public class DateConverter implements Converter<Temporal, Object> {
62  
63      private final ZoneId zoneId = ZoneId.systemDefault();
64      private final DateFieldDefinition definition;
65  
66      @Inject
67      public DateConverter(DateFieldDefinition definition) {
68          this.definition = definition;
69      }
70  
71      @Override
72      public Result<Object> convertToModel(Temporal value, ValueContext valueContext) { // Temporal (LocalDate or LocalDateTime) to Date
73          if (value instanceof LocalDate) {
74              return Result.ok(Date.from(((LocalDate) value).atStartOfDay(zoneId).toInstant()));
75          }
76          return Result.ok(Optional.ofNullable(value)
77                  .map(nonNullDateTime -> Date.from(((LocalDateTime) nonNullDateTime).atZone(zoneId).toInstant()))
78                  .orElse(null));
79      }
80  
81      @Override
82      public Temporal convertToPresentation(Object value, ValueContext valueContext) { // Date (or String) to Temporal (LocalDate or LocalDateTime)
83          if (value == null) {
84              return null;
85          }
86  
87          if (value instanceof String) {
88              return asTemporal((String) value);
89          }
90  
91          Converter converter = definition.isTime() ?
92                  new LocalDateTimeToDateConverter(zoneId) :
93                  new LocalDateToDateConverter(zoneId);
94  
95          return (Temporal) converter.convertToPresentation(value, valueContext);
96      }
97  
98      private Temporal asTemporal(String defaultValue) {
99          if (DateFieldDefinition.NOW.equalsIgnoreCase(defaultValue)) {
100             return definition.isTime() ? LocalDateTime.now() : LocalDate.now();
101         }
102 
103         if (definition.isTime()) {
104             return LocalDateTime.parse(defaultValue, DateTimeFormatter.ofPattern(definition.getDateFormat() + " " + definition.getTimeFormat(), Locale.ENGLISH));
105         } else {
106             return LocalDate.parse(defaultValue, DateTimeFormatter.ofPattern(definition.getDateFormat(), Locale.ENGLISH));
107         }
108     }
109 }