ch.agent.t2.timeutil

Class DateTimeScanner

java.lang.Object

ch.agent.t2.timeutil.DateTimeScanner

public class DateTimeScanner
extends Object

DateTimeScanner supports the interpretation of strings as TimeIndex objects.

Here is an example of use:

 String pattern = 
     "\\S+ (\\S+) (\\d+) (\\d\\d):(\\d\\d):(\\d\\d) \\S+ (\\d\\d\\d\\d)";
 int[] groups = {6, 1, 2, 3, 4, 5};
 String[] months = 
     {"Jan", "Feb", "Mar", "Apr", "May", "Jun", 
      "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"};
 DateTimeScanner scanner = new DateTimeScanner(pattern, groups);
 scanner.setMonths(months);
 TimeIndex time = scanner.scan(DateTime.DOMAIN, "Wed Nov 30 12:29:23 UTC 2010");
 assertEquals("2010-11-30 12:29:23", time.toString());
 

Author:

Jean-Paul Vetterli

Constructor Summary

Constructors

Constructor and Description
DateTimeScanner(String pattern, int[] groups) Construct a date time scanner with the given pattern and groups.

Method Summary

Modifier and Type	Method and Description
TimeIndex	scan(String date) Scan the date using the default domain.
TimeIndex	scan(TimeDomain domain, String date) Scan the date in the given time domain.
void	setDomain(TimeDomain domain) Set the default time domain.
void	setMonths(String[] keywords) Define textual months.
void	setTwoDigitYearThreshold(int threshold) Set a threshold to trigger special handling of two digit years.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeScanner

public DateTimeScanner(String pattern,
                       int[] groups)
                throws T2Exception

Construct a date time scanner with the given pattern and groups. The pattern is parsed by Pattern. If the pattern is null, scanning is done directly by TimeDomain.time(String). Group indexes can be specified in an array, with 1 for the first group. When the groups array is null, group indexes are assumed to be in increasing sequence. Group indexes are useless when the pattern is null.

Parameters:

pattern - a pattern or null

groups - an array of indexes or null

Throws:

T2Exception

Method Detail

setDomain

public void setDomain(TimeDomain domain)

Set the default time domain. It will be used when dates are scanned without specifying a domain by scan(String).

Parameters:

domain - a time domain

setMonths

public void setMonths(String[] keywords)

Define textual months. The method can be used repeatedly to define multiple keywords for months.

Parameters:

keywords - an array of 12 month keywords

setTwoDigitYearThreshold

public void setTwoDigitYearThreshold(int threshold)

Set a threshold to trigger special handling of two digit years. When a non-negative threshold is defined, a year in the range [0, 99] is handled using the following rule:

• if the year is less than the threshold, 2000 is added,
• else 1900 is added.

Specify a threshold of 0 to always add 1900 and a threshold of 100 (or more) to always add 2000.

By default the threshold is negative, and there is no special handling of two digit years.

Parameters:

threshold -

scan

public TimeIndex scan(String date)
               throws T2Exception

Scan the date using the default domain. The default domain must be set with setDomain(TimeDomain).

Parameters:

date - a non-null date/time

Returns:

a TimeIndex in the default domain

Throws:

T2Exception

scan

public TimeIndex scan(TimeDomain domain,
                      String date)
               throws T2Exception

Scan the date in the given time domain.

Parameters:

domain - a non-null time domain

date - a non-null date/time

Returns:

a TimeIndex in the given domain

Throws:

T2Exception