io.rapidpro.expressions.dates

Class DateParser

java.lang.Object

io.rapidpro.expressions.dates.DateParser

public class DateParser
extends Object

Flexible date parser for human written dates

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DateParser.Component
protected static class	DateParser.Mode

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	AM
protected static DateParser.Component[][]	DATE_SEQUENCES_DAY_FIRST
protected static DateParser.Component[][]	DATE_SEQUENCES_MONTH_FIRST
protected DateStyle	m_dateStyle
protected org.threeten.bp.LocalDate	m_now
protected org.threeten.bp.ZoneId	m_timezone
protected static Map<String,Integer>	MONTHS_BY_ALIAS
protected static int	PM
protected static DateParser.Component[][]	TIME_SEQUENCES

Constructor Summary

Constructors

Constructor and Description
DateParser(org.threeten.bp.LocalDate now, org.threeten.bp.ZoneId timezone, DateStyle dateStyle) Creates a new date parser

Method Summary

Methods

Modifier and Type	Method and Description
org.threeten.bp.temporal.Temporal	auto(String text) Returns a date or datetime depending on what information is available
protected static List<DateParser.Component[]>	getPossibleSequences(DateParser.Mode mode, int length, DateStyle dateStyle) Gets possible component sequences in the given mode
protected static Map<DateParser.Component,Integer>	getTokenPossibilities(String token, DateParser.Mode mode) Returns all possible component types of a token without regard to its context.
protected static Map<String,Integer>	loadMonthAliases(String file) Loads month aliases from the given resource file
protected static org.threeten.bp.temporal.Temporal	makeResult(Map<DateParser.Component,Integer> values, org.threeten.bp.LocalDate now, org.threeten.bp.ZoneId timezone) Makes a date or datetime or time object from a map of component values
protected org.threeten.bp.temporal.Temporal	parse(String text, DateParser.Mode mode) Returns a date, datetime or time depending on what information is available
org.threeten.bp.OffsetTime	time(String text) Tries to parse a time value from the given text
protected static int	yearFrom2Digits(int shortYear, int currentYear) Converts a relative 2-digit year to an absolute 4-digit year

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MONTHS_BY_ALIAS

protected static final Map<String,Integer> MONTHS_BY_ALIAS

AM

protected static final int AM

See Also:

Constant Field Values

PM

protected static final int PM

See Also:

Constant Field Values

DATE_SEQUENCES_DAY_FIRST

protected static final DateParser.Component[][] DATE_SEQUENCES_DAY_FIRST

DATE_SEQUENCES_MONTH_FIRST

protected static final DateParser.Component[][] DATE_SEQUENCES_MONTH_FIRST

TIME_SEQUENCES

protected static final DateParser.Component[][] TIME_SEQUENCES

m_now

protected final org.threeten.bp.LocalDate m_now

m_timezone

protected final org.threeten.bp.ZoneId m_timezone

m_dateStyle

protected final DateStyle m_dateStyle

Constructor Detail

DateParser

public DateParser(org.threeten.bp.LocalDate now,
          org.threeten.bp.ZoneId timezone,
          DateStyle dateStyle)

Creates a new date parser

Parameters:

now - the now which parsing happens relative to

timezone - the timezone in which times are interpreted if input doesn't include an offset

dateStyle - whether dates are usually entered day first or month first

Method Detail

auto

public org.threeten.bp.temporal.Temporal auto(String text)

Returns a date or datetime depending on what information is available

Parameters:

text - the text to parse

Returns:

the parsed date or datetime

time

public org.threeten.bp.OffsetTime time(String text)

Tries to parse a time value from the given text

Parameters:

text - the text to parse

Returns:

the parsed time

parse

protected org.threeten.bp.temporal.Temporal parse(String text,
                                      DateParser.Mode mode)

Returns a date, datetime or time depending on what information is available

getPossibleSequences

protected static List<DateParser.Component[]> getPossibleSequences(DateParser.Mode mode,
                                                int length,
                                                DateStyle dateStyle)

Gets possible component sequences in the given mode

Parameters:

mode - the mode

length - the length (only returns sequences of this length)

dateStyle - whether dates are usually entered day first or month first

Returns:

the list of sequences

getTokenPossibilities

protected static Map<DateParser.Component,Integer> getTokenPossibilities(String token,
                                                      DateParser.Mode mode)

Returns all possible component types of a token without regard to its context. For example "26" could be year, date or minute, but can't be a month or an hour.

Parameters:

token - the token to classify

Returns:

the map of possible types and values if token was of that type

makeResult

protected static org.threeten.bp.temporal.Temporal makeResult(Map<DateParser.Component,Integer> values,
                                           org.threeten.bp.LocalDate now,
                                           org.threeten.bp.ZoneId timezone)

Makes a date or datetime or time object from a map of component values

Parameters:

values - the component values

timezone - the current timezone

Returns:

the date, datetime, time or null if values are invalid

yearFrom2Digits

protected static int yearFrom2Digits(int shortYear,
                  int currentYear)

Converts a relative 2-digit year to an absolute 4-digit year

Parameters:

shortYear - the relative year

Returns:

the absolute year

loadMonthAliases

protected static Map<String,Integer> loadMonthAliases(String file)
                                               throws IOException

Loads month aliases from the given resource file

Throws:

IOException