Module datarush.library

Package com.pervasive.datarush.encoding.text

Class PeriodFormatter

java.lang.Object

com.pervasive.datarush.encoding.text.PeriodFormatter

All Implemented Interfaces:

TokenFormatter

public class PeriodFormatter
extends Object

Constructor Summary

Constructors

Constructor	Description
PeriodFormatter(IntervalFormatting format, String nullIndicator)	Creates a formatter using the specified format.
PeriodFormatter(String format)	Creates a formatter using the specified format.

Method Summary

Modifier and Type	Method	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

PeriodFormatter

public PeriodFormatter(String format)

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

Parameters:

format - the output format to use

PeriodFormatter

public PeriodFormatter(IntervalFormatting 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