Package net.sf.saxon.number
Interface Numberer
- All Known Implementing Classes:
Numberer_de
,Numberer_en
,Numberer_fr
public interface Numberer
Interface Numberer supports number formatting. There is a separate
implementation for each language, e.g. Numberer_en for English.
This supports the xsl:number element
- Author:
- Michael H. Kay
-
Method Summary
Modifier and TypeMethodDescriptiondayName
(int day, int minWidth, int maxWidth) Get a day name or abbreviationformat
(long number, String picture, int groupSize, String groupSeparator, String letterValue, String ordinal) Format a number into a stringgetCalendarName
(String code) Get the name of a calendargetEraName
(int year) Get the name for an era (e.g.getOrdinalSuffixForDateTime
(String component) Get an ordinal suffix for a particular component of a date/time.getTimezoneName
(int tz) Get the name of a timezonehalfDayName
(int minutes, int minWidth, int maxWidth) Get an am/pm indicatormonthName
(int month, int minWidth, int maxWidth) Get a month name or abbreviationvoid
setCountry
(String country) Set the country used by this numberer (currently used only for names of timezones)
-
Method Details
-
setCountry
Set the country used by this numberer (currently used only for names of timezones) -
format
String format(long number, String picture, int groupSize, String groupSeparator, String letterValue, String ordinal) Format a number into a string- Parameters:
number
- The number to be formattedpicture
- 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 digitsletterValue
- 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.
-
monthName
Get a month name or abbreviation- Parameters:
month
- The month number (1=January, 12=December)minWidth
- The minimum number of charactersmaxWidth
- The maximum number of characters
-
dayName
Get a day name or abbreviation- Parameters:
day
- The month number (1=Monday, 7=Sunday)minWidth
- The minimum number of charactersmaxWidth
- The maximum number of characters
-
halfDayName
Get an am/pm indicator- Parameters:
minutes
- the minutes within the dayminWidth
- minimum width of outputmaxWidth
- maximum width of output- Returns:
- the AM or PM indicator
-
getOrdinalSuffixForDateTime
Get an ordinal suffix for a particular component of a date/time.- 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
Get the name for an era (e.g. "BC" or "AD")- Parameters:
year
- the proleptic gregorian year, using "0" for the year before 1AD
-
getTimezoneName
Get the name of a timezone- Parameters:
tz
- the offset of the timezone from GMT in minutes
-
getCalendarName
Get the name of a calendar- Parameters:
code
- The code representing the calendar as in the XSLT 2.0 spec, e.g. AD for the Gregorian calendar
-