net.sf.saxon.number
Class AbstractNumberer

java.lang.Object
  net.sf.saxon.number.AbstractNumberer

All Implemented Interfaces:

Serializable, Numberer

Direct Known Subclasses:

Numberer_da, Numberer_de, Numberer_en, Numberer_fr, Numberer_frBE, Numberer_it, Numberer_nl, Numberer_nlBE, Numberer_sv

public abstract class AbstractNumberer
extends Object
implements Numberer, Serializable

Class AbstractNumberer is a base implementation of Numberer that provides language-independent default numbering This supports the xsl:number element. Methods and data are declared as protected, and static is avoided, to allow easy subclassing.

Author:

Michael H. Kay

See Also:

Serialized Form

Field Summary

static int	LOWER_CASE
static int	TITLE_CASE
static int	UPPER_CASE

Constructor Summary

AbstractNumberer()

Method Summary

abstract String	dayName(int day, int minWidth, int maxWidth) Get a day name or abbreviation
String	format(long number, String picture, int groupSize, String groupSeparator, String letterValue, String ordinal) Format a number into a string
String	getCalendarName(String code) Get the name of a calendar
String	getCountry() Get the country used by this numberer
String	getEraName(int year) Get the name for an era (e.g.
String	getOrdinalSuffixForDateTime(String component) Get an ordinal suffix for a particular component of a date/time.
String	halfDayName(int minutes, int minWidth, int maxWidth) Get an am/pm indicator.
abstract String	monthName(int month, int minWidth, int maxWidth) Get a month name or abbreviation
void	setCountry(String country) Set the country used by this numberer (currenly used only for names of timezones)
abstract String	toOrdinalWords(String ordinalParam, long number, int wordCase) Show an ordinal number as English words in a requested case (for example, Twentyfirst)
static String	toRoman(long n) Generate a Roman numeral (in lower case)
abstract String	toWords(long number) Show the number as words in title case.
String	toWords(long number, int wordCase) Format a number as English words with specified case options

Methods inherited from class java.lang.Object

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

Field Detail

UPPER_CASE

public static final int UPPER_CASE

See Also:

Constant Field Values

LOWER_CASE

public static final int LOWER_CASE

See Also:

Constant Field Values

TITLE_CASE

public static final int TITLE_CASE

See Also:

Constant Field Values

Constructor Detail

AbstractNumberer

public AbstractNumberer()

Method Detail

setCountry

public void setCountry(String country)

Set the country used by this numberer (currenly used only for names of timezones)

Specified by:

setCountry in interface Numberer

getCountry

public String getCountry()

Get the country used by this numberer

Specified by:

getCountry in interface Numberer

format

public String format(long number,
                     String picture,
                     int groupSize,
                     String groupSeparator,
                     String letterValue,
                     String ordinal)

Format a number into a string

Specified by:

format in interface Numberer

Parameters:

number - The number to be formatted

picture - The format token. This is a single component of the format attribute of xsl:number, e.g. "1", "01", "i", or "a"

groupSize - number of digits per group (0 implies no grouping)

groupSeparator - string to appear between groups of digits

letterValue - The letter-value specified to xsl:number: "alphabetic" or "traditional". Can also be an empty string or null.

ordinal - The value of the ordinal attribute specified to xsl:number The value "yes" indicates that ordinal numbers should be used; "" or null indicates that cardinal numbers

Returns:

the formatted number. Note that no errors are reported; if the request is invalid, the number is formatted as if the string() function were used.

toRoman

public static String toRoman(long n)

Generate a Roman numeral (in lower case)

Parameters:

n - the number to be formatted

Returns:

the Roman numeral representation of the number in lower case

toWords

public abstract String toWords(long number)

Show the number as words in title case. (We choose title case because the result can then be converted algorithmically to lower case or upper case).

Parameters:

number - the number to be formatted

Returns:

the number formatted as English words

toWords

public String toWords(long number,
                      int wordCase)

Format a number as English words with specified case options

Parameters:

number - the number to be formatted

wordCase - the required case for example UPPER_CASE, LOWER_CASE, TITLE_CASE

Returns:

the formatted number

toOrdinalWords

public abstract String toOrdinalWords(String ordinalParam,
                                      long number,
                                      int wordCase)

Show an ordinal number as English words in a requested case (for example, Twentyfirst)

Parameters:

ordinalParam - the value of the "ordinal" attribute as supplied by the user

number - the number to be formatted

wordCase - the required case for example UPPER_CASE, LOWER_CASE, TITLE_CASE

Returns:

the formatted number

monthName

public abstract String monthName(int month,
                                 int minWidth,
                                 int maxWidth)

Get a month name or abbreviation

Specified by:

monthName in interface Numberer

Parameters:

month - The month number (1=January, 12=December)

minWidth - The minimum number of characters

maxWidth - The maximum number of characters

dayName

public abstract String dayName(int day,
                               int minWidth,
                               int maxWidth)

Get a day name or abbreviation

Specified by:

dayName in interface Numberer

Parameters:

day - The day of the week (1=Monday, 7=Sunday)

minWidth - The minimum number of characters

maxWidth - The maximum number of characters

halfDayName

public String halfDayName(int minutes,
                          int minWidth,
                          int maxWidth)

Get an am/pm indicator. Default implementation works for English, on the basis that some other languages might like to copy this (most non-English countries don't actually use the 12-hour clock, so it's irrelevant).

Specified by:

halfDayName in interface Numberer

Parameters:

minutes - the minutes within the day

minWidth - minimum width of output

maxWidth - maximum width of output

Returns:

the AM or PM indicator

getOrdinalSuffixForDateTime

public String getOrdinalSuffixForDateTime(String component)

Get an ordinal suffix for a particular component of a date/time.

Specified by:

getOrdinalSuffixForDateTime in interface Numberer

Parameters:

component - the component specifier from a format-dateTime picture, for example "M" for the month or "D" for the day.

Returns:

a string that is acceptable in the ordinal attribute of xsl:number to achieve the required ordinal representation. For example, "-e" for the day component in German, to have the day represented as "dritte August".

getEraName

public String getEraName(int year)

Get the name for an era (e.g. "BC" or "AD")

Specified by:

getEraName in interface Numberer

Parameters:

year - the proleptic gregorian year, using "0" for the year before 1AD

getCalendarName

public String getCalendarName(String code)

Get the name of a calendar

Specified by:

getCalendarName in interface Numberer

Parameters:

code - The code representing the calendar as in the XSLT 2.0 spec, e.g. AD for the Gregorian calendar