com.arcway.cockpit.docgen.provider.interfaces

Interface IDateTimeProvider

public interface IDateTimeProvider

The IDateTimeProvider provides methods to access date and time information for document generation. The IDateTimeProvider can be referenced directly within a document template by its name dateTimeProvider.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrentDate() Returns the current date as string.
java.lang.Long	getCurrentDateTime_MilliSecondsSince_01_01_1970() getCurrentDateTime_MilliSecondsSince_01_01_1970 Returns the current date and time messured in milli seconds since 01/01/1970.
java.lang.String	getCurrentDateTime() Returns the current date and time as string.
java.lang.String	getCurrentTime() Returns the current time as string.
java.lang.String	printTimestampInCustomFormat(java.lang.Long milliSecondSince_01_01_1970, java.lang.String pattern) Allows you to format a date value (milli seconds since 01/01/1970) into a string representation using any user-defined patterns for date-time formatting.
java.lang.String	printTimestampInISO8601Format(java.lang.Long milliSecondSince_01_01_1970, boolean includingTime) Formats a date value (milli seconds since 01/01/1970) into a string representation according to ISO8601.

Method Detail

getCurrentDate

java.lang.String getCurrentDate()

Returns the current date as string.

Returns:

current date as string

getCurrentDateTime_MilliSecondsSince_01_01_1970

java.lang.Long getCurrentDateTime_MilliSecondsSince_01_01_1970()

getCurrentDateTime_MilliSecondsSince_01_01_1970

Returns the current date and time messured in milli seconds since 01/01/1970.

Returns:

current date and time as string

getCurrentDateTime

java.lang.String getCurrentDateTime()

Returns the current date and time as string.

Returns:

current date and time as string

getCurrentTime

java.lang.String getCurrentTime()

Returns the current time as string.

Returns:

current time as string

printTimestampInCustomFormat

java.lang.String printTimestampInCustomFormat(java.lang.Long milliSecondSince_01_01_1970,
                                              java.lang.String pattern)

Allows you to format a date value (milli seconds since 01/01/1970) into a string representation using any user-defined patterns for date-time formatting.

Date and Time Patterns

Date and time formats are specified by date and time pattern strings. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "''" represents a single quote. All other characters are not interpreted; they're simply copied into the output string during formatting or matched against the input string during parsing.

The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):

Letter	Date or Time Component	Presentation	Examples
G	Era designator	Text	AD
y	Year	Year	1996; 96
M	Month in year	Month	July; Jul; 07
w	Week in year	Number	27
W	Week in month	Number	2
D	Day in year	Number	189
d	Day in month	Number	10
F	Day of week in month	Number	2
E	Day in week	Text	Tuesday; Tue
a	Am/pm marker	Text	PM
H	Hour in day (0-23)	Number	0
k	Hour in day (1-24)	Number	24
K	Hour in am/pm (0-11)	Number	0
h	Hour in am/pm (1-12)	Number	12
m	Minute in hour	Number	30
s	Second in minute	Number	55
S	Millisecond	Number	978
z	Time zone	General time zone	Pacific Standard Time; PST; GMT-08:00
Z	Time zone	RFC 822 time zone	-0800

Pattern letters are usually repeated, as their number determines the exact presentation:

• Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
• Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless it's needed to separate two adjacent fields.
• Year: For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.

  For parsing, if the number of pattern letters is more than 2, the year is interpreted literally, regardless of the number of digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.

• Month: If the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted as a number.
• General time zone: Time zones are interpreted as text if they have names. For time zones representing a GMT offset value, the following syntax is used:

       GMTOffsetTimeZone:
               GMT Sign Hours : Minutes
       Sign: one of
               + -
       Hours:
               Digit
               Digit Digit
       Minutes:
               Digit Digit
       Digit: one of
               0 1 2 3 4 5 6 7 8 9
   

  Hours must be between 0 and 23, and Minutes must be between 00 and 59. The format is locale independent and digits must be taken from the Basic Latin block of the Unicode standard.
• RFC 822 time zone: For formatting, the RFC 822 4-digit time zone format is used:

       RFC822TimeZone:
               Sign TwoDigitHours Minutes
       TwoDigitHours:
               Digit Digit
   

  TwoDigitHours must be between 00 and 23. Other definitions are as for general time zones.

Examples

The following examples show how date and time patterns are interpreted in the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.

Date and Time Pattern	Result
"yyyy.MM.dd G 'at' HH:mm:ss z"	2001.07.04 AD at 12:08:56 PDT
"EEE, MMM d, ''yy"	Wed, Jul 4, '01
"h:mm a"	12:08 PM
"hh 'o''clock' a, zzzz"	12 o'clock PM, Pacific Daylight Time
"K:mm a, z"	0:08 PM, PDT
"yyyyy.MMMMM.dd GGG hh:mm aaa"	02001.July.04 AD 12:08 PM
"EEE, d MMM yyyy HH:mm:ss Z"	Wed, 4 Jul 2001 12:08:56 -0700
"yyMMddHHmmssZ"	010704120856-0700
"yyyy-MM-dd'T'HH:mm:ss.SSSZ"	2001-07-04T12:08:56.235-0700

Parameters:

milliSecondSince_01_01_1970 - date time in milli seconds since 01/01/1970

pattern - formatting pattern

Returns:

formatted date time string representation or "-" when no time was given

printTimestampInISO8601Format

java.lang.String printTimestampInISO8601Format(java.lang.Long milliSecondSince_01_01_1970,
                                               boolean includingTime)

Formats a date value (milli seconds since 01/01/1970) into a string representation according to ISO8601.

Parameters:

milliSecondSince_01_01_1970 - date time in milli seconds since 01/01/1970

includingTime - whether the time shall be included in the string representation

Returns:

formatted date time string representation or "-" when no time was given