-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
DateValue.java
445 lines (398 loc) · 15.8 KB
/
DateValue.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
/*
* Copyright (c) 2002-2018 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.values.storable;
import java.time.Clock;
import java.time.DateTimeException;
import java.time.LocalDate;
import java.time.LocalTime;
import java.time.OffsetTime;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.time.temporal.ChronoField;
import java.time.temporal.IsoFields;
import java.time.temporal.TemporalUnit;
import java.util.function.Supplier;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.neo4j.values.StructureBuilder;
import org.neo4j.values.ValueMapper;
import org.neo4j.values.virtual.MapValue;
import static java.lang.Integer.parseInt;
import static java.util.Objects.requireNonNull;
import static org.neo4j.util.FeatureToggles.flag;
import static org.neo4j.values.storable.DateTimeValue.parseZoneName;
import static org.neo4j.values.storable.IntegralValue.safeCastIntegral;
public final class DateValue extends TemporalValue<LocalDate,DateValue>
{
public static DateValue date( LocalDate value )
{
return new DateValue( requireNonNull( value, "LocalDate" ) );
}
public static DateValue date( int year, int month, int day )
{
return new DateValue( LocalDate.of( year, month, day ) );
}
public static DateValue weekDate( int year, int week, int dayOfWeek )
{
return new DateValue( localWeekDate( year, week, dayOfWeek ) );
}
public static DateValue quarterDate( int year, int quarter, int dayOfQuarter )
{
return new DateValue( localQuarterDate( year, quarter, dayOfQuarter ) );
}
public static DateValue ordinalDate( int year, int dayOfYear )
{
return new DateValue( LocalDate.ofYearDay( year, dayOfYear ) );
}
public static DateValue epochDate( long epochDay )
{
return new DateValue( LocalDate.ofEpochDay( epochDay ) );
}
public static DateValue parse( CharSequence text )
{
return parse( DateValue.class, PATTERN, DateValue::parse, text );
}
public static DateValue parse( TextValue text )
{
return parse( DateValue.class, PATTERN, DateValue::parse, text );
}
public static DateValue now( Clock clock )
{
return new DateValue( LocalDate.now( clock ) );
}
public static DateValue now( Clock clock, String timezone )
{
return now( clock.withZone( parseZoneName( timezone ) ) );
}
public static DateValue build( MapValue map, Supplier<ZoneId> defaultZone )
{
return StructureBuilder.build( builder( defaultZone ), map );
}
public static DateValue select( org.neo4j.values.AnyValue from, Supplier<ZoneId> defaultZone )
{
return builder( defaultZone ).selectDate( from );
}
public static DateValue truncate(
TemporalUnit unit,
TemporalValue input,
MapValue fields,
Supplier<ZoneId> defaultZone )
{
throw new UnsupportedOperationException( "not implemented" );
}
static DateBuilder builder( Supplier<ZoneId> defaultZone )
{
return new DateBuilder( defaultZone );
}
private final LocalDate value;
private DateValue( LocalDate value )
{
this.value = value;
}
@Override
int unsafeCompareTo( Value otherValue )
{
DateValue other = (DateValue) otherValue;
return value.compareTo( other.value );
}
@Override
LocalDate temporal()
{
return value;
}
@Override
LocalDate getDatePart()
{
return value;
}
@Override
LocalTime getLocalTimePart()
{
throw new IllegalArgumentException( String.format( "Cannot get the time of: %s", this ) );
}
@Override
OffsetTime getTimePart( Supplier<ZoneId> defaultZone )
{
throw new IllegalArgumentException( String.format( "Cannot get the time of: %s", this ) );
}
@Override
public boolean equals( Value other )
{
return other instanceof DateValue && value.equals( ((DateValue) other).value );
}
@Override
public <E extends Exception> void writeTo( ValueWriter<E> writer ) throws E
{
writer.writeDate( value.toEpochDay() );
}
@Override
public String prettyPrint()
{
return value.format( DateTimeFormatter.ISO_DATE );
}
@Override
public ValueGroup valueGroup()
{
return ValueGroup.DATE;
}
@Override
protected int computeHash()
{
return Long.hashCode( value.toEpochDay() );
}
@Override
public <T> T map( ValueMapper<T> mapper )
{
return mapper.mapDate( this );
}
@Override
public DateValue add( DurationValue duration )
{
return replacement( value.plusMonths( duration.totalMonths() ).plusDays( duration.totalDays() ) );
}
@Override
public DateValue sub( DurationValue duration )
{
return replacement( value.minusMonths( duration.totalMonths() ).minusDays( duration.totalDays() ) );
}
@Override
DateValue replacement( LocalDate date )
{
return date == value ? this : new DateValue( date );
}
static final boolean QUARTER_DATES = flag( DateValue.class, "QUARTER_DATES", true );
/**
* The regular expression pattern for parsing dates. All fields come in two versions - long and short form, the
* long form is for formats containing dashes, the short form is for formats without dashes. The long format is
* the only one that handles signed years, since that is how the only case that supports years with other than 4
* numbers, and not having dashes then would make the format ambiguous. In order to not have two cases that can
* parse only the year, we let the long case handle that.
* <p/>
* Valid formats:
* <ul>
* <li>Year:<ul>
* <li>{@code [0-9]{4}} - unique without dashes, since it is the only one 4 numbers long<br>
* Parsing: {@code longYear}</li>
* <li>{@code [+-] [0-9]{1,9}}<br>
* Parsing: {@code longYear}</li>
* </ul></li>
* <li>Year & Month:<ul>
* <li>{@code [0-9]{4} [0-9]{2}} - unique without dashes, since it is the only one 6 numbers long<br>
* Parsing: {@code shortYear, shortMonth}</li>
* <li>{@code [0-9]{4} - [0-9]{1,2}}<br>
* Parsing: {@code longYear, longMonth}</li>
* <li>{@code [+-] [0-9]{1,9} - [0-9]{1,2}}<br>
* Parsing: {@code longYear, longMonth}</li>
* </ul></li>
* <li>Calendar date (Year & Month & Day):<ul>
* <li>{@code [0-9]{4} [0-9]{2} [0-9]{2}} - unique without dashes, since it is the only one 8 numbers long<br>
* Parsing: {@code shortYear, shortMonth, shortDay}</li>
* <li>{@code [0-9]{4} - [0-9]{1,2} - [0-9]{1,2}}<br>
* Parsing: {@code longYear, longMonth, longDay}</li>
* <li>{@code [+-] [0-9]{1,9} - [0-9]{1,2} - [0-9]{1,2}}<br>
* Parsing: {@code longYear, longMonth, longDay}</li>
* </ul></li>
* <li>Year & Week:<ul>
* <li>{@code [0-9]{4} W [0-9]{2}}<br>
* Parsing: {@code shortYear, shortWeek}</li>
* <li>{@code [0-9]{4} - W [0-9]{2}}<br>
* Parsing: {@code longYear, longWeek}</li>
* <li>{@code [+-] [0-9]{1,9} - W [0-9]{2}}<br>
* Parsing: {@code longYear, longWeek}</li>
* </ul></li>
* <li>Week date (year & week & day of week):<ul>
* <li>{@code [0-9]{4} W [0-9]{2} [0-9]} - unique without dashes, contains W followed by 2 numbers<br>
* Parsing: {@code shortYear, shortWeek, shortDOW}</li>
* <li>{@code [0-9]{4} - W [0-9]{1,2} - [0-9]}<br>
* Parsing: {@code longYear, longWeek, longDOW}</li>
* <li>{@code [+-] [0-9]{1,9} - W [0-9]{2} - [0-9]}<br>
* Parsing: {@code longYear, longWeek, longDOW}</li>
* </ul></li>
* <li>Ordinal date (year & day of year):<ul>
* <li>{@code [0-9]{4} [0-9]{3}} - unique without dashes, since it is the only one 7 number long<br>
* Parsing: {@code shortYear, shortDOY}</li>
* <li>{@code [0-9]{4} - [0-9]{3}} - needs to be exactly 3 numbers long to distinguish from Year & Month<br>
* Parsing: {@code longYear, longDOY}</li>
* <li>{@code [+-] [0-9]{1,9} - [0-9]{3}} - needs to be exactly 3 numbers long to distinguish from Year & Month<br>
* Parsing: {@code longYear, longDOY}</li>
* </ul></li>
* </ul>
*/
static final String DATE_PATTERN = "(?:"
// short formats - without dashes:
+ "(?<shortYear>[0-9]{4})(?:"
+ "(?<shortMonth>[0-9]{2})(?<shortDay>[0-9]{2})?|" // calendar date
+ "W(?<shortWeek>[0-9]{2})(?<shortDOW>[0-9])?|" // week date
+ (QUARTER_DATES ? "Q(?<shortQuarter>[0-9])(?<shortDOQ>[0-9]{2})?|" : "") // quarter date
+ "(?<shortDOY>[0-9]{3}))" + "|" // ordinal date
// long formats - includes dashes:
+ "(?<longYear>(?:[0-9]{4}|[+-][0-9]{1,9}))(?:"
+ "-(?<longMonth>[0-9]{1,2})(?:-(?<longDay>[0-9]{1,2}))?|" // calendar date
+ "-W(?<longWeek>[0-9]{1,2})(?:-(?<longDOW>[0-9]))?|" // week date
+ (QUARTER_DATES ? "-Q(?<longQuarter>[0-9])(?:-(?<longDOQ>[0-9]{1,2}))?|" : "") // quarter date
+ "-(?<longDOY>[0-9]{3}))?" + ")"; // ordinal date
private static final Pattern PATTERN = Pattern.compile( DATE_PATTERN );
/**
* Creates a {@link LocalDate} from a {@link Matcher} that matches the regular expression defined by
* {@link #DATE_PATTERN}. The decision tree in the implementation of this method is guided by the parsing notes
* for {@link #DATE_PATTERN}.
*
* @param matcher
* a {@link Matcher} that matches the regular expression defined in {@link #DATE_PATTERN}.
* @return a {@link LocalDate} parsed from the given {@link Matcher}.
*/
static LocalDate parseDate( Matcher matcher )
{
String longYear = matcher.group( "longYear" );
if ( longYear != null )
{
return parse( matcher, parseInt( longYear ),
"longMonth", "longDay", "longWeek", "longDOW", "longQuarter", "longDOQ", "longDOY" );
}
else
{
return parse( matcher, parseInt( matcher.group( "shortYear" ) ),
"shortMonth", "shortDay", "shortWeek", "shortDOW", "shortQuarter", "shortDOQ", "shortDOY" );
}
}
private static LocalDate parse(
Matcher matcher, int year,
String MONTH, String DAY, String WEEK, String DOW, String QUARTER, String DOQ, String DOY )
{
String month = matcher.group( MONTH );
if ( month != null )
{
return LocalDate.of( year, parseInt( month ), optInt( matcher.group( DAY ) ) );
}
String week = matcher.group( WEEK );
if ( week != null )
{
return localWeekDate( year, parseInt( week ), optInt( matcher.group( DOW ) ) );
}
String quarter = matcher.group( QUARTER );
if ( quarter != null )
{
return localQuarterDate( year, parseInt( quarter ), optInt( matcher.group( DOQ ) ) );
}
String doy = matcher.group( DOY );
if ( doy != null )
{
return LocalDate.ofYearDay( year, parseInt( doy ) );
}
return LocalDate.of( year, 1, 1 );
}
private static DateValue parse( Matcher matcher )
{
return new DateValue( parseDate( matcher ) );
}
private static int optInt( String value )
{
return value == null ? 1 : parseInt( value );
}
private static LocalDate localWeekDate( int year, int week, int dayOfWeek )
{
LocalDate weekOne = LocalDate.of( year, 1, 4 ); // the fourth is guaranteed to be in week 1 by definition
LocalDate withWeek = weekOne.with( IsoFields.WEEK_OF_WEEK_BASED_YEAR, week );
// the implementation of WEEK_OF_WEEK_BASED_YEAR uses addition to adjust the date, this means that it accepts
// week 53 of years that don't have 53 weeks, so we have to guard for this:
if ( week == 53 && withWeek.get( IsoFields.WEEK_BASED_YEAR ) != year )
{
throw new DateTimeException( String.format( "Year %d does not contain %d weeks.", year, week ) );
}
return withWeek.with( ChronoField.DAY_OF_WEEK, dayOfWeek );
}
private static LocalDate localQuarterDate( int year, int quarter, int dayOfQuarter )
{
// special handling for the range of Q1 and Q2, since they are shorter than Q3 and Q4
if ( quarter == 2 && dayOfQuarter == 92 )
{
throw new DateTimeException( "Quarter 2 only has 91 days." );
}
// instantiate the yearDate now, because we use it to know if it is a leap year
LocalDate yearDate = LocalDate.ofYearDay( year, dayOfQuarter ); // guess on the day
if ( quarter == 1 && dayOfQuarter > 90 && (!yearDate.isLeapYear() || dayOfQuarter == 92) )
{
throw new DateTimeException( String.format(
"Quarter 1 of %d only has %d days.", year, yearDate.isLeapYear() ? 91 : 90 ) );
}
return yearDate
.with( IsoFields.QUARTER_OF_YEAR, quarter )
.with( IsoFields.DAY_OF_QUARTER, dayOfQuarter );
}
static final LocalDate DEFAULT_CALENDER_DATE = LocalDate.of( Field.year.defaultValue, Field.month.defaultValue, Field.day.defaultValue );
private static class DateBuilder extends Builder<DateValue>
{
DateBuilder( Supplier<ZoneId> defaultZone )
{
super( defaultZone );
}
@Override
protected final boolean supportsDate()
{
return true;
}
@Override
protected final boolean supportsTime()
{
return false;
}
private LocalDate getDateOf( org.neo4j.values.AnyValue temporal )
{
if ( temporal instanceof TemporalValue )
{
TemporalValue v = (TemporalValue) temporal;
return v.getDatePart();
}
throw new IllegalArgumentException( String.format( "Cannot construct date from: %s", temporal ) );
}
@Override
public DateValue buildInternal()
{
LocalDate result;
if ( fields.containsKey( Field.date ) )
{
result = getDateOf( fields.get( Field.date ) );
}
else if ( fields.containsKey( Field.week ) )
{
// Be sure to be in the start of the week based year (which can be later than 1st Jan)
result = DEFAULT_CALENDER_DATE
.with( IsoFields.WEEK_BASED_YEAR, safeCastIntegral( Field.year.name(), fields.get( Field.year ),
Field.year.defaultValue ) )
.with( IsoFields.WEEK_OF_WEEK_BASED_YEAR, 1 )
.with( ChronoField.DAY_OF_WEEK, 1 );
}
else
{
result = DEFAULT_CALENDER_DATE;
}
result = assignAllFields( result );
return date( result );
}
DateValue selectDate( org.neo4j.values.AnyValue date )
{
if ( date instanceof DateValue )
{
return (DateValue) date;
}
return date( getDateOf( date ) );
}
}
}