com.pervasive.datarush.encoding.text

Class DateFormatter

java.lang.Object

com.pervasive.datarush.encoding.text.DateFormatter

All Implemented Interfaces:

TokenFormatter

public class DateFormatter
extends Object

A formatter representing date token values with a user-defined text format.

Parsing is done using the Joda time library which uses a similar format to that described in SimpleDateFormat. Most specifiers compatible with the JDK will be compatible with Joda time, the notable exceptions being:

• The 'W' (week in month) specifier is not supported.
• The 'F' (day of week as number) specifier is replaced with 'e'.

Constructor Summary

Constructors

Constructor and Description
DateFormatter(DateTimeFormatting format, String nullIndicator) Creates a formatter using the specified format.
DateFormatter(String pattern) Creates a formatter using the specified format.

Method Summary

Modifier and Type	Method and Description
String	format() Formats the current value of the source as a text value.
void	setSource(ScalarValued source) Sets the container holding values to be formatted.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateFormatter

public DateFormatter(String pattern)

Creates a formatter using the specified format. Null values are output as the empty string.

Parameters:

pattern - the output format to use

DateFormatter

public DateFormatter(DateTimeFormatting format,
                     String nullIndicator)

Creates a formatter using the specified format. Null values are output as the specified string.

Parameters:

format - the output format to use

nullIndicator - the text value to use for null values

Method Detail

setSource

public final void setSource(ScalarValued source)

Description copied from interface: TokenFormatter

Sets the container holding values to be formatted. A reference to this container is held and accessed only when an formatting is requested.

Specified by:

setSource in interface TokenFormatter

Parameters:

source - the value container to format

format

public final String format()

Description copied from interface: TokenFormatter

Formats the current value of the source as a text value.

Specified by:

format in interface TokenFormatter

Returns:

the value of the source as a string