DateParser (de.mpg.mpi-inf:javatools 1.1 API)

java.lang.Object
- javatools.parsers.DateParser

```
public class DateParser
extends Object
```
Copyright 2016 Fabian M. Suchanek Licensed 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. The DateParser normalizes date expressions in english natural language text to ISO-dates
year-month-day
where year is either positive negative. The DateParser understands expressions like "4th century BC" or "3rd of November 2004". Dates may be underspecified: The character '#' stands for "at least one digit".
Example:
```
 DateParser.normalize("It was November 23rd to 24th 1998.")
          --> "It was 1998-11-23 to 1998-11-24."
          DateParser.getDate("It was 1998-11-23 to 1998-11-24.")
          -->  1998, 11, 23
          NumberFormatter.ISOtime(DateParser.getCalendar("November 24th 1998"))
          --> 1998-12-24 T 00:00:00.00
 
```
TODO 1st century transformed to 0##-##-##. Should be 00##-##-##. Just padding doesn't work because millenium would then be padded too much (need to distinguish between centuries and millenias).

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DATE`
`static Pattern`	`DATEPATTERN`
`static Pattern`	`JUSTDATEPATTERN`
`static String`	`SDATE`
`static Pattern`	`SDATEPATTERN`
`static Pattern`	`SIMPLEYEARPATTERN` A year as a pattern
`static Pattern`	`YEARPATTERN`

Constructor Summary

Constructors
Constructor and Description

DateParser()

Constructors
Constructor and Description
`DateParser()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Calendar`	`asCalendar(int[] date)` Converts a normalized Date to a Calendar
`static Calendar`	`asCalendar(String date)`
`static Calendar`	`asCalendar(String[] date)`
`static int[]`	`asInts(String[] yearMonthDay)` Parses the normalized date into ints, putting Integer.MAX_VALUE for '#'.
`static boolean`	`disjoint(int[] date1, int[] date2)` TRUE if the dates are disjoint, i.e.
`static boolean`	`disjoint(String[] date1, String[] date2)`
`static boolean`	`disjoint(String date1, String date2)`
`static boolean`	`equal(int[] date1, int[] date2)` TRUE if the dates are exactly equal, including '#'
`static boolean`	`equal(String[] date1, String[] date2)`
`static boolean`	`equal(String date1, String date2)`
`static Collection<Triple<String,Integer,Integer>>`	`getAllDatePositions(CharSequence s)` Returns all the dates values and their position in the text
`static Collection<Triple<String,Integer,Integer>>`	`getAllDatePositions(CharSequence s, Language language)` Returns all the dates values and their position in the text
`static Collection<String>`	`getAllDates(CharSequence s)` Normalizes all dates in a String
`static Collection<String>`	`getAllDates(CharSequence s, Language language)` Normalizes all dates in a String
`static String[]`	`getDate(CharSequence d)` Returns the components of the date (year, month, day) in a normalized date string (or null)
`static String[]`	`getDate(CharSequence d, int[] pos)` Returns the components of the date (year, month, day) in a normalized date string (or null) and writes the start and end position in pos[0] and pos[1]
`static List<String>`	`getDates(CharSequence d)` Returns the dates in a normalized date string
`static boolean`	`includes(int[] date1, int[] date2)` TRUE if the first date includes the second, e.g., 1800-##-## includes 1800-05-##
`static boolean`	`includes(String[] date1, String[] date2)`
`static boolean`	`includes(String date1, String date2)`
`static boolean`	`isDate(CharSequence s)` Tells whether this string is a normlized date (and nothing else)
`static boolean`	`isEarlier(int[] date1, int[] date2)` TRUE if the first date is earlier than the second.
`static boolean`	`isEarlier(String[] date1, String[] date2)` TRUE if the first date is earlier than the second.
`static boolean`	`isEarlier(String date1, String date2)`
`static void`	`main(String[] argv)` Test routine
`protected static boolean`	`matches(String a, String b)` TRUE if the first String matches the second
`static String`	`newDate(int y, int m, int d)` Creates a date-string from a day, month and year as ints
`static String`	`newDate(String y, String m, String d)` Creates a date-string of the form "year-month-day"
`static String`	`newSubDate(String y, String m)` Creates a date-string of the form "year-month-day"
`static String`	`normalize(CharSequence s)` Normalizes all dates in a String
`static String`	`normalize(CharSequence s, Language language)` Normalizes all dates in a String Note: If you bugfix something in this version, please check for applying the same fix at the position change tracking function below
`static String`	`normalize(CharSequence s, Language language, PositionTracker posTracker)` Normalizes all dates in a String keeping track of the position changes with respect to the newly created string Note: If you bugfix something in this version, please try and check for applying the same fix at the non-tracking function
`static String`	`normalize(CharSequence s, PositionTracker posTracker)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATE
```
public static final String DATE
```

DATEPATTERN

public static final Pattern DATEPATTERN

JUSTDATEPATTERN

public static final Pattern JUSTDATEPATTERN

SDATE
```
public static final String SDATE
```

SDATEPATTERN

public static final Pattern SDATEPATTERN

SIMPLEYEARPATTERN

public static final Pattern SIMPLEYEARPATTERN

A year as a pattern

YEARPATTERN

public static final Pattern YEARPATTERN

Constructor Detail
- DateParser
```
public DateParser()
```

Method Detail

newDate

public static final String newDate(String y,
                                   String m,
                                   String d)

Creates a date-string of the form "year-month-day"

newDate

public static final String newDate(int y,
                                   int m,
                                   int d)

Creates a date-string from a day, month and year as ints

newSubDate

public static final String newSubDate(String y,
                                      String m)

Creates a date-string of the form "year-month-day"

normalize

public static String normalize(CharSequence s)

Normalizes all dates in a String

normalize
```
public static String normalize(CharSequence s,
                               Language language)
```
Normalizes all dates in a String Note: If you bugfix something in this version, please check for applying the same fix at the position change tracking function below

normalize

public static String normalize(CharSequence s,
                               PositionTracker posTracker)

normalize
```
public static String normalize(CharSequence s,
                               Language language,
                               PositionTracker posTracker)
```
Normalizes all dates in a String keeping track of the position changes with respect to the newly created string Note: If you bugfix something in this version, please try and check for applying the same fix at the non-tracking function

getAllDates

public static Collection<String> getAllDates(CharSequence s)

Normalizes all dates in a String

getAllDates

public static Collection<String> getAllDates(CharSequence s,
                                             Language language)

Normalizes all dates in a String

getAllDatePositions

public static Collection<Triple<String,Integer,Integer>> getAllDatePositions(CharSequence s)

Returns all the dates values and their position in the text

getAllDatePositions

public static Collection<Triple<String,Integer,Integer>> getAllDatePositions(CharSequence s,
                                                                             Language language)

Returns all the dates values and their position in the text

getDate
```
public static String[] getDate(CharSequence d,
                               int[] pos)
```
Returns the components of the date (year, month, day) in a normalized date string (or null) and writes the start and end position in pos[0] and pos[1]

getDates

public static List<String> getDates(CharSequence d)

Returns the dates in a normalized date string

getDate
```
public static String[] getDate(CharSequence d)
```
Returns the components of the date (year, month, day) in a normalized date string (or null)

isDate
```
public static boolean isDate(CharSequence s)
```
Tells whether this string is a normlized date (and nothing else)

asCalendar

public static Calendar asCalendar(int[] date)

Converts a normalized Date to a Calendar

asCalendar

public static Calendar asCalendar(String[] date)

asCalendar

public static Calendar asCalendar(String date)

matches

protected static boolean matches(String a,
                                 String b)

TRUE if the first String matches the second

asInts
```
public static int[] asInts(String[] yearMonthDay)
```
Parses the normalized date into ints, putting Integer.MAX_VALUE for '#'. This looses partial information in the year!! (e.g. 18## -> ####)

isEarlier
```
public static boolean isEarlier(int[] date1,
                                int[] date2)
```
TRUE if the first date is earlier than the second. This does not define a total order on dates, as,e.g., 1800-##-## is neither earlier nor later than 1800-05-##

isEarlier
```
public static boolean isEarlier(String[] date1,
                                String[] date2)
```
TRUE if the first date is earlier than the second. This does not define a total order on dates, as,e.g., 1800-##-## is neither earlier nor later than 1800-05-##

isEarlier

public static boolean isEarlier(String date1,
                                String date2)

includes

public static boolean includes(int[] date1,
                               int[] date2)

TRUE if the first date includes the second, e.g., 1800-##-## includes 1800-05-##

includes

public static boolean includes(String[] date1,
                               String[] date2)

includes

public static boolean includes(String date1,
                               String date2)

equal

public static boolean equal(int[] date1,
                            int[] date2)

TRUE if the dates are exactly equal, including '#'

equal

public static boolean equal(String[] date1,
                            String[] date2)

equal

public static boolean equal(String date1,
                            String date2)

disjoint

public static boolean disjoint(int[] date1,
                               int[] date2)

TRUE if the dates are disjoint, i.e. none includes the other

disjoint

public static boolean disjoint(String[] date1,
                               String[] date2)

disjoint

public static boolean disjoint(String date1,
                               String date2)

main

public static void main(String[] argv)
                 throws Exception

Test routine

Throws:: Exception

Class DateParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATE

DATEPATTERN

JUSTDATEPATTERN

SDATE

SDATEPATTERN

SIMPLEYEARPATTERN

YEARPATTERN

Constructor Detail

DateParser

Method Detail

newDate

newDate

newSubDate

normalize

normalize

normalize

normalize

getAllDates

getAllDates

getAllDatePositions

getAllDatePositions

getDate

getDates

getDate

isDate

asCalendar

asCalendar

asCalendar

matches

asInts

isEarlier

isEarlier

isEarlier

includes

includes

includes

equal

equal

equal

disjoint

disjoint

disjoint

main