sirius.kernel.commons

Class AdvancedDateParser

java.lang.Object

sirius.kernel.commons.AdvancedDateParser

public class AdvancedDateParser
extends Object

A flexible parser which can parse dates like DD.MM.YYYY or YYYY/DD/MM along with some computations.

A valid expression is defined by the following grammar:

• ROOT ::= (MODIFIER ",")* (":")? ("now" | DATE)? (("+" | "-") NUMBER (UNIT)?)
• UNIT ::= ("day" | "days" | "week" | "weeks" | "month" | "months" | "year" | "years")
• NUMBER ::=(0-9)+
• DATE ::= GERMAN_DATE | ENGLISH_DATE | YM_EXPRESSION
• GERMAN_DATE ::= NUMBER "." NUMBER ("." NUMBER)? (NUMBER (":" NUMBER (":" NUMBER)?)?)?
• ENGLISH_DATE ::= NUMBER "/" NUMBER ("/" NUMBER)? (NUMBER (":" NUMBER (":" NUMBER)?)?)? ("am" | "pm")?)?
• YM_EXPRESSION ::= NUMBER
• MODIFIER ::= ("start" | "end") ("of")? ("day" | "week" | "month" | "year")

Examples

• now - actual date
• 1.1 - first of january of current year
• +1 or now + 1 day - tomorrow
• start of week: now - 1 year - start of the week of day one year ago

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdvancedDateParser.DateSelection Combines the parsed text along with the effective date (as Calendar).

Constructor Summary

Constructors

Constructor and Description
AdvancedDateParser(String lang) Creates a new parser for the given language to use.

Method Summary

Modifier and Type	Method and Description
AdvancedDateParser.DateSelection	parse(String input) Parses the given input and returns a DateSelection as result.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvancedDateParser

public AdvancedDateParser(String lang)

Creates a new parser for the given language to use.

Parameters:

lang - contains the two letter language code to obtain the translations for the available modifiers etc.

Method Detail

parse

public AdvancedDateParser.DateSelection parse(String input)
                                       throws ParseException

Parses the given input and returns a DateSelection as result.

Note that an AdvancedDateParser is stateful an is therefore neither reusable nor thread-safe.

Parameters:

input - the text to parse

Returns:

a DateSelection containing the effective date along with the parsed expression

Throws:

ParseException - if the input cannot be parsed as it does not conform to the given grammar