Module datarush.library

Package com.pervasive.datarush.encoding.text

Class BooleanFormatter

java.lang.Object

com.pervasive.datarush.encoding.text.BooleanFormatter

All Implemented Interfaces:

TokenFormatter

public class BooleanFormatter
extends Object

A formatter representing boolean token values as user-specified text values.

Constructor Summary

Constructors

Constructor	Description
BooleanFormatter(TruthValues mapping)	Creates a formatter using the specified mapping.
BooleanFormatter(TruthValues mapping, String nullIndicator)	Creates a formatter using the specified mapping.

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

BooleanFormatter

public BooleanFormatter(TruthValues mapping)

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

Parameters:

mapping - the mapping of boolean values to strings

BooleanFormatter

public BooleanFormatter(TruthValues mapping,
                        String nullIndicator)

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

Parameters:

mapping - the mapping of boolean values to strings

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