CalendarParser

java.lang.Object
- com.fgm.javaUtils.CalendarParser

public class CalendarParser
extends java.lang.Object

A parser for arbitrary date/time strings.

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`CENTURY_OFFSET` Adjustment for two-digit years will break in 2050.
`static int`	`DD_MM_YY` day/month/year order.
`static int`	`DD_YY_MM` day/year/month order.
`private static boolean`	`DEBUG` set to `true` to enable debugging.
`static int`	`MM_DD_YY` month/day/year order.
`static int`	`MM_YY_DD` month/year/day order.
`static int`	`MONTH_AFTER_DAY` bit indicating that the month comes after the day.
`static int`	`MONTH_BEFORE_DAY` bit indicating that the month comes before the day.
`private static java.lang.String[][]`	`MONTHS` list of month abbreviations and names.
`private static int`	`PLACE_HOUR` Parsing hour value from time string.
`private static int`	`PLACE_MILLI` Parsing millisecond value from time string.
`private static int`	`PLACE_MINUTE` Parsing minute value from time string.
`private static int`	`PLACE_SECOND` Parsing second value from time string.
`private static int`	`PLACE_UNKNOWN` Unknown place in time parsing.
`private static int`	`UNSET` value indicating an unset variable.
`private static java.lang.String[]`	`WEEKDAY_NAMES` list of weekday names.
`static int`	`YEAR_AFTER_DAY` bit indicating that the year comes after the day.
`static int`	`YEAR_AFTER_MONTH` bit indicating that the year comes after the month.
`static int`	`YEAR_BEFORE_DAY` bit indicating that the year comes before the day.
`static int`	`YEAR_BEFORE_MONTH` bit indicating that the year comes before the month.
`static int`	`YY_DD_MM` year/day/month order.
`static int`	`YY_MM_DD` year/month/day order.
`private static java.lang.String[]`	`zoneNames` list of time zone names.

Constructor Summary

Constructors
Constructor and Description

CalendarParser()

Constructors
Constructor and Description
`CalendarParser()`

Method Summary

Methods
Modifier and Type	Method and Description
`private static void`	`appendTimeString(java.lang.StringBuffer buf, java.util.Calendar cal, boolean needSpace)` Append formatted time string to the string buffer.
`static java.lang.String`	`getOrderString(int order)` Return a string representation of the order value.
`private static int`	`getOrdinalNumber(java.lang.String str)` Translate a string representation of an ordinal number to the appropriate numeric value. For example, `"1st"` would return `1`, `"23rd"` would return `23`, etc.
`private static java.lang.String`	`getTimePlaceString(int place)` Get name of current place in time.
`private static boolean`	`isWeekdayName(java.lang.String str)` Determine is the supplied string is a value weekday name.
`private static java.lang.String[]`	`loadTimeZoneNames()` Load list of time zones if sun.util.calendar.ZoneInfo exists.
`static int`	`monthNameToNumber(java.lang.String str)` Convert the supplied month name to its numeric representation.
`static java.util.Calendar`	`parse(java.lang.String dateStr)` Extract a date from a string, defaulting to YY-MM-DD order for all-numeric strings.
`static java.util.Calendar`	`parse(java.lang.String dateStr, int order)` Extract a date from a string.
`static java.util.Calendar`	`parse(java.lang.String dateStr, int order, boolean ignoreChanges)` Extract a date from a string.
`private static void`	`parseNonNumericToken(java.lang.String dateStr, ParserState state, java.lang.String token)` Parse a non-numeric token from the date string.
`private static void`	`parseNumericBlob(java.lang.String dateStr, ParserState state, int val)` Split a large numeric value into a year/month/date values.
`private static void`	`parseNumericToken(java.lang.String dateStr, ParserState state, int val)` Use a numeric token from the date string.
`private static java.util.Calendar`	`parseString(java.lang.String dateStr, int order, boolean ignoreChanges)` Extract a date from the supplied string.
`private static void`	`parseTime(java.lang.String dateStr, ParserState state, java.lang.String timeStr)` Parse a time string.
`private static void`	`parseTimeZoneOffset(java.lang.String dateStr, ParserState state, java.lang.String zoneStr)` Parse a time zone offset string.
`static java.lang.String`	`prettyString(java.util.Calendar cal)` Return a printable representation of the date.
`static java.lang.String`	`toSQLString(java.util.Calendar cal)` Return a string representation of the date suitable for use in an SQL statement.
`static java.lang.String`	`toString(java.util.Calendar cal)` Return a basic representation of the string.

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

- Field Detail
  - YEAR_BEFORE_MONTH
```
public static final int YEAR_BEFORE_MONTH
```
    bit indicating that the year comes before the month.
    
    See Also:
    Constant Field Values
  - YEAR_BEFORE_DAY
```
public static final int YEAR_BEFORE_DAY
```
    bit indicating that the year comes before the day.
    
    See Also:
    Constant Field Values
  - MONTH_BEFORE_DAY
```
public static final int MONTH_BEFORE_DAY
```
    bit indicating that the month comes before the day.
    
    See Also:
    Constant Field Values
  - YEAR_AFTER_MONTH
```
public static final int YEAR_AFTER_MONTH
```
    bit indicating that the year comes after the month.
    
    See Also:
    Constant Field Values
  - YEAR_AFTER_DAY
```
public static final int YEAR_AFTER_DAY
```
    bit indicating that the year comes after the day.
    
    See Also:
    Constant Field Values
  - MONTH_AFTER_DAY
```
public static final int MONTH_AFTER_DAY
```
    bit indicating that the month comes after the day.
    
    See Also:
    Constant Field Values
  - DD_MM_YY
```
public static final int DD_MM_YY
```
    day/month/year order.
    
    See Also:
    Constant Field Values
  - MM_DD_YY
```
public static final int MM_DD_YY
```
    month/day/year order.
    
    See Also:
    Constant Field Values
  - MM_YY_DD
```
public static final int MM_YY_DD
```
    month/year/day order.
    
    See Also:
    Constant Field Values
  - DD_YY_MM
```
public static final int DD_YY_MM
```
    day/year/month order.
    
    See Also:
    Constant Field Values
  - YY_DD_MM
```
public static final int YY_DD_MM
```
    year/day/month order.
    
    See Also:
    Constant Field Values
  - YY_MM_DD
```
public static final int YY_MM_DD
```
    year/month/day order.
    
    See Also:
    Constant Field Values
  - zoneNames
```
private static final java.lang.String[] zoneNames
```
    list of time zone names.
  - PLACE_UNKNOWN
```
private static final int PLACE_UNKNOWN
```
    Unknown place in time parsing.
    
    See Also:
    Constant Field Values
  - PLACE_HOUR
```
private static final int PLACE_HOUR
```
    Parsing hour value from time string.
    
    See Also:
    Constant Field Values
  - PLACE_MINUTE
```
private static final int PLACE_MINUTE
```
    Parsing minute value from time string.
    
    See Also:
    Constant Field Values
  - PLACE_SECOND
```
private static final int PLACE_SECOND
```
    Parsing second value from time string.
    
    See Also:
    Constant Field Values
  - PLACE_MILLI
```
private static final int PLACE_MILLI
```
    Parsing millisecond value from time string.
    
    See Also:
    Constant Field Values
  - CENTURY_OFFSET
```
private static final int CENTURY_OFFSET
```
    Adjustment for two-digit years will break in 2050.
    
    See Also:
    Constant Field Values
  - UNSET
```
private static final int UNSET
```
    value indicating an unset variable.
    
    See Also:
    Constant Field Values
  - DEBUG
```
private static final boolean DEBUG
```
    set to true to enable debugging.
    
    See Also:
    Constant Field Values
  - WEEKDAY_NAMES
```
private static final java.lang.String[] WEEKDAY_NAMES
```
    list of weekday names.
  - MONTHS
```
private static final java.lang.String[][] MONTHS
```
    list of month abbreviations and names.
- Constructor Detail
  - CalendarParser
```
public CalendarParser()
```
- Method Detail
  - appendTimeString
```
private static final void appendTimeString(java.lang.StringBuffer buf,
                    java.util.Calendar cal,
                    boolean needSpace)
```
    Append formatted time string to the string buffer.
    
    Parameters:
    buf - string buffer
    cal - object containing time
    needSpace - true if a space character should be inserted before any data
  - getOrderString
```
public static final java.lang.String getOrderString(int order)
```
    Return a string representation of the order value.
    
    Parameters:
    order - order
    
    Returns:
    order string
  - getOrdinalNumber
```
private static final int getOrdinalNumber(java.lang.String str)
```
    Translate a string representation of an ordinal number to the appropriate numeric value.
    For example, "1st" would return 1, "23rd" would return 23, etc.
    
    Parameters:
    str - ordinal string
    
    Returns:
    the numeric value of the ordinal number, or CalendarParser.UNSET if the supplied string is not a valid ordinal number.
  - getTimePlaceString
```
private static final java.lang.String getTimePlaceString(int place)
```
    Get name of current place in time.
    
    Parameters:
    place - place ID
    
    Returns:
    place name ("hour", "minute", etc.
  - isWeekdayName
```
private static final boolean isWeekdayName(java.lang.String str)
```
    Determine is the supplied string is a value weekday name.
    
    Parameters:
    str - weekday name to check
    
    Returns:
    true if the supplied string is a weekday name.
  - loadTimeZoneNames
```
private static final java.lang.String[] loadTimeZoneNames()
```
    Load list of time zones if sun.util.calendar.ZoneInfo exists.
    
    Returns:
    null if time zone list cannot be loaded.
  - monthNameToNumber
```
public static int monthNameToNumber(java.lang.String str)
```
    Convert the supplied month name to its numeric representation.
    For example, "January" (or any substring) would return 1 and "December" would return 12.
    
    Parameters:
    str - month name
    
    Returns:
    the numeric month, or CalendarParser.UNSET if the supplied string is not a valid month name.
  - parse
```
public static final java.util.Calendar parse(java.lang.String dateStr)
                                      throws CalendarParserException
```
    Extract a date from a string, defaulting to YY-MM-DD order for all-numeric strings.
    
    Parameters:
    dateStr - date string
    
    Returns:
    parsed date
    
    Throws:
    
    CalendarParserException - if there was a problem parsing the string.
  - parse
```
public static final java.util.Calendar parse(java.lang.String dateStr,
                       int order)
                                      throws CalendarParserException
```
    Extract a date from a string.
    
    Parameters:
    dateStr - date string
    order - order in which pieces of numeric strings are assigned (should be one of YY_MM_DD, MM_DD_YY, etc.)
    
    Returns:
    parsed date
    
    Throws:
    
    CalendarParserException - if there was a problem parsing the string.
  - parse
```
public static final java.util.Calendar parse(java.lang.String dateStr,
                       int order,
                       boolean ignoreChanges)
                                      throws CalendarParserException
```
    Extract a date from a string.
    
    Parameters:
    dateStr - date string
    order - order in which pieces of numeric strings are assigned (should be one of YY_MM_DD, MM_DD_YY, etc.)
    ignoreChanges - if true, ignore date changes such as Feb 31 being changed to Mar 3.
    
    Returns:
    parsed date
    
    Throws:
    
    CalendarParserException - if there was a problem parsing the string.
  - parseNonNumericToken
```
private static final void parseNonNumericToken(java.lang.String dateStr,
                        ParserState state,
                        java.lang.String token)
                                        throws CalendarParserException
```
    Parse a non-numeric token from the date string.
    
    Parameters:
    dateStr - full date string
    state - parser state
    token - string being parsed
    
    Throws:
    
    CalendarParserException - if there was a problem parsing the token
  - parseNumericBlob
```
private static final void parseNumericBlob(java.lang.String dateStr,
                    ParserState state,
                    int val)
                                    throws CalendarParserException
```
    Split a large numeric value into a year/month/date values.
    
    Parameters:
    dateStr - full date string
    state - parser state
    val - numeric value to use
    
    Throws:
    
    CalendarParserException - if there was a problem splitting the value
  - parseNumericToken
```
private static final void parseNumericToken(java.lang.String dateStr,
                     ParserState state,
                     int val)
                                     throws CalendarParserException
```
    Use a numeric token from the date string.
    
    Parameters:
    dateStr - full date string
    state - parser state
    val - numeric value to use
    
    Throws:
    
    CalendarParserException - if there was a problem parsing the token
  - parseString
```
private static final java.util.Calendar parseString(java.lang.String dateStr,
                             int order,
                             boolean ignoreChanges)
                                             throws CalendarParserException
```
    Extract a date from the supplied string.
    
    Parameters:
    dateStr - string to parse
    order - year/month/day order (YY_MM_DD, MM_DD_YY, etc.)
    ignoreChanges - if true, ignore date changes such as Feb 31 being changed to Mar 3.
    
    Returns:
    parsed date
    
    Throws:
    
    CalendarParserException - if no valid date was found.
  - parseTime
```
private static final void parseTime(java.lang.String dateStr,
             ParserState state,
             java.lang.String timeStr)
                             throws CalendarParserException
```
    Parse a time string.
    
    Parameters:
    dateStr - full date string
    state - parser state
    timeStr - string containing colon-separated time
    
    Throws:
    
    CalendarParserException - if there is a problem with the time
  - parseTimeZoneOffset
```
private static final void parseTimeZoneOffset(java.lang.String dateStr,
                       ParserState state,
                       java.lang.String zoneStr)
                                       throws CalendarParserException
```
    Parse a time zone offset string.
    
    Parameters:
    dateStr - full date string
    state - parser state
    zoneStr - string containing colon-separated time zone offset
    
    Throws:
    
    CalendarParserException - if there is a problem with the time
  - prettyString
```
public static final java.lang.String prettyString(java.util.Calendar cal)
```
    Return a printable representation of the date.
    
    Parameters:
    cal - calendar to convert to a string
    
    Returns:
    a printable string.
  - toString
```
public static final java.lang.String toString(java.util.Calendar cal)
```
    Return a basic representation of the string.
    
    Parameters:
    cal - calendar to convert to a string
    
    Returns:
    the basic string.
  - toSQLString
```
public static final java.lang.String toSQLString(java.util.Calendar cal)
```
    Return a string representation of the date suitable for use in an SQL statement.
    
    Parameters:
    cal - calendar to convert to a string
    
    Returns:
    the SQL-friendly string.

Class CalendarParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

YEAR_BEFORE_MONTH

YEAR_BEFORE_DAY

MONTH_BEFORE_DAY

YEAR_AFTER_MONTH

YEAR_AFTER_DAY

MONTH_AFTER_DAY

DD_MM_YY

MM_DD_YY

MM_YY_DD

DD_YY_MM

YY_DD_MM

YY_MM_DD

zoneNames

PLACE_UNKNOWN

PLACE_HOUR

PLACE_MINUTE

PLACE_SECOND

PLACE_MILLI

CENTURY_OFFSET

UNSET

DEBUG

WEEKDAY_NAMES

MONTHS

Constructor Detail

CalendarParser

Method Detail

appendTimeString

getOrderString

getOrdinalNumber

getTimePlaceString

isWeekdayName

loadTimeZoneNames

monthNameToNumber

parse

parse

parse

parseNonNumericToken

parseNumericBlob

parseNumericToken

parseString

parseTime

parseTimeZoneOffset

prettyString

toString

toSQLString