net.sf.saxon.number

Class NumberFormatter

java.lang.Object

net.sf.saxon.number.NumberFormatter

All Implemented Interfaces:

Serializable

public class NumberFormatter
extends Object
implements Serializable

Class NumberFormatter defines a method to format a ArrayList of integers as a character string according to a supplied format specification.

Author:

Michael H. Kay

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Method	isLetterOrDigitMethod
static boolean	methodInitialized

Constructor Summary

Constructors

Constructor and Description
NumberFormatter()

Method Summary

Modifier and Type	Method and Description
CharSequence	format(List numbers, int groupSize, String groupSeparator, String letterValue, String ordinal, Numberer numberer) Format a list of numbers.
static int	getDigitValue(int in) Determine whether a character represents a digit and if so, which digit.
void	prepare(String format) Tokenize the format pattern.

Methods inherited from class java.lang.Object

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

Field Detail

methodInitialized

public static boolean methodInitialized

isLetterOrDigitMethod

public static Method isLetterOrDigitMethod

Constructor Detail

NumberFormatter

public NumberFormatter()

Method Detail

prepare

public void prepare(String format)

Tokenize the format pattern.

Parameters:

format - the format specification. Contains one of the following values:

• "1": conventional decimal numbering
• "a": sequence a, b, c, ... aa, ab, ac, ...
• "A": sequence A, B, C, ... AA, AB, AC, ...
• "i": sequence i, ii, iii, iv, v ...
• "I": sequence I, II, III, IV, V, ...

This symbol may be preceded and followed by punctuation (any other characters) which is copied to the output string.

getDigitValue

public static int getDigitValue(int in)

Determine whether a character represents a digit and if so, which digit.

Parameters:

in - the Unicode character being tested. It's known that this is alphanumeric.

Returns:

-1 if it's not a digit, otherwise the digit value.

format

public CharSequence format(List numbers,
                           int groupSize,
                           String groupSeparator,
                           String letterValue,
                           String ordinal,
                           Numberer numberer)

Format a list of numbers.

Parameters:

numbers - the numbers to be formatted (a sequence of integer values; it may also contain preformatted strings as part of the error recovery fallback)

Returns:

the formatted output string.