sapphire.util

Class M18NUtil

java.lang.Object

sapphire.util.M18NUtil

All Implemented Interfaces:

java.io.Serializable

public class M18NUtil
extends java.lang.Object
implements java.io.Serializable

This utility class is designed to provide sapphire M18N date and number parsing and formatting functionalities.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
M18NUtil() Creates a new instance of M18NUtil using jvm default locale and timezone
M18NUtil(com.labvantage.sapphire.services.ConnectionInfo connectionInfo) Creates a new instance of M18NUtil using the connectionInfo specified
M18NUtil(java.io.File rakFile, com.labvantage.sapphire.services.ConnectionInfo connectionInfo) Creates a new instance of M18NUtil using the connectionInfo specified
M18NUtil(java.util.Locale locale, java.util.TimeZone timezone) Creates a new instance of M18NUtil using the locale and time
M18NUtil(PageContext pageContext) Creates a new instance of M18NUtil using the pageContext specified

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(java.math.BigDecimal bigDecimal) Formats a BigDecimal into a local-sensitive String
java.lang.String	format(java.math.BigDecimal bigDecimal, boolean group) Formats a BigDecimal into a local-sensitive String
java.lang.String	format(java.math.BigDecimal bigDecimal, boolean group, boolean stripTrailingZeros) Formats a BigDecimal into a local-sensitive String
java.lang.String	format(java.util.Calendar calendar) Formats a Calender into date time string according to user locale and timezone
java.lang.String	format(java.util.Calendar calendar, boolean userTimeZoneSensitive) Formats a Calender into date time string according to user locale and with or without user timezone adjustment
java.lang.String	formatDateOnly(java.util.Calendar calendar) Formats a Calender into date only string according to user locale and timezone
java.lang.String	formatDateOnly(java.util.Calendar calendar, boolean userTimeZoneSensitive) Formats a Calender into date only string according to user locale and with or without user timezone adjustment
java.time.format.DateTimeFormatter	getDateFormatter(java.time.ZoneId displayZone)
java.time.format.DateTimeFormatter	getDateTimeFormatter(java.time.ZoneId displayZone)
java.text.DateFormat	getDefaultDateFormat()
java.text.DateFormat	getDefaultDateFormat(boolean userTimeZoneSensitive)
java.text.DateFormat	getDefaultDateOnlyFormat()
java.text.DateFormat	getDefaultDateOnlyFormat(boolean userTimeZoneSensitive)
java.util.Locale	getLocale()
java.util.Locale	getLocaleForDateTime()
java.util.Calendar	getNowCalendar()
java.text.DateFormat	getSysQueryDateFormat()
java.time.format.DateTimeFormatter	getTimeFormatter(java.time.ZoneId displayZone)
java.util.TimeZone	getTimezone() Return the time zone used to format and parse date time string by this object in user's time zone
boolean	isRelDate(java.lang.String date)
boolean	isRelDate(java.lang.String date, boolean dateonly)
java.math.BigDecimal	parseBigDecimal(java.lang.String value) Parses a locale-sensitive String into a BigDecimal
java.util.Calendar	parseCalendar(java.lang.String datetime) Parse a date time string into a Calender object assuming the user'local and timezone
java.util.Calendar	parseCalendar(java.lang.String datetime, boolean userTimeZoneSensitive) Parse a date time string into a Calender object assuming the user'local and with or without user timezone adjustment String
java.sql.Timestamp	parseTimestamp(java.lang.String datetime)
java.sql.Timestamp	parseTimestamp(java.lang.String datetime, boolean userTimeZoneSensitive)
void	setTimeZone(java.util.TimeZone timeZone) Set the user Time Zone.

Methods inherited from class java.lang.Object

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

Constructor Detail

M18NUtil

public M18NUtil()

Creates a new instance of M18NUtil using jvm default locale and timezone

M18NUtil

public M18NUtil(com.labvantage.sapphire.services.ConnectionInfo connectionInfo)

Creates a new instance of M18NUtil using the connectionInfo specified

Parameters:

connectionInfo - The connectionInfo that contains user locale and timezone info etc.

M18NUtil

public M18NUtil(java.io.File rakFile,
                com.labvantage.sapphire.services.ConnectionInfo connectionInfo)

Creates a new instance of M18NUtil using the connectionInfo specified

Parameters:

connectionInfo - The connectionInfo that contains user locale and timezone info etc.

rakFile - The rak file.

M18NUtil

public M18NUtil(PageContext pageContext)

Creates a new instance of M18NUtil using the pageContext specified

Parameters:

pageContext - The pageContext from inside a jsp page.

M18NUtil

public M18NUtil(java.util.Locale locale,
                java.util.TimeZone timezone)

Creates a new instance of M18NUtil using the locale and time

Parameters:

locale - The locale to use.

timezone - The time zone to use.

Method Detail

parseCalendar

public java.util.Calendar parseCalendar(java.lang.String datetime)

Parse a date time string into a Calender object assuming the user'local and timezone

Parameters:

datetime - The datetime string to parse

Returns:

the parsed Calendar object

parseCalendar

public java.util.Calendar parseCalendar(java.lang.String datetime,
                                        boolean userTimeZoneSensitive)

Parse a date time string into a Calender object assuming the user'local and with or without user timezone adjustment String

Parameters:

datetime - The datetime string to parse

userTimeZoneSensitive - Whether parsing according to user's timezone

Returns:

the parsed Calendar object

format

public java.lang.String format(java.util.Calendar calendar)

Formats a Calender into date time string according to user locale and timezone

Parameters:

calendar - The Calendar value to format

Returns:

the formatted date and time string

formatDateOnly

public java.lang.String formatDateOnly(java.util.Calendar calendar)

Formats a Calender into date only string according to user locale and timezone

Parameters:

calendar - The Calendar value to format

Returns:

the formatted date only string

format

public java.lang.String format(java.util.Calendar calendar,
                               boolean userTimeZoneSensitive)

Formats a Calender into date time string according to user locale and with or without user timezone adjustment

Parameters:

calendar - The Calendar value to format

userTimeZoneSensitive - - whether format to user's time zone

Returns:

the formatted date and time string

formatDateOnly

public java.lang.String formatDateOnly(java.util.Calendar calendar,
                                       boolean userTimeZoneSensitive)

Formats a Calender into date only string according to user locale and with or without user timezone adjustment

Parameters:

calendar - The Calendar value to format

userTimeZoneSensitive - - whether format to user's time zone

Returns:

the formatted date only string

getDateTimeFormatter

public java.time.format.DateTimeFormatter getDateTimeFormatter(java.time.ZoneId displayZone)

getDateFormatter

public java.time.format.DateTimeFormatter getDateFormatter(java.time.ZoneId displayZone)

getTimeFormatter

public java.time.format.DateTimeFormatter getTimeFormatter(java.time.ZoneId displayZone)

getDefaultDateFormat

public java.text.DateFormat getDefaultDateFormat()

Returns:

the default date and time DateFormat object

getDefaultDateOnlyFormat

public java.text.DateFormat getDefaultDateOnlyFormat()

Returns:

the default date only DateFormat for date only object

getSysQueryDateFormat

public java.text.DateFormat getSysQueryDateFormat()

Returns:

the DateFormat for formatting to the date pattern in sapphire queries

getDefaultDateFormat

public java.text.DateFormat getDefaultDateFormat(boolean userTimeZoneSensitive)

Parameters:

userTimeZoneSensitive - - whether the returned DateFormat is in user's timezone

Returns:

the default date and time DateFormat object

getDefaultDateOnlyFormat

public java.text.DateFormat getDefaultDateOnlyFormat(boolean userTimeZoneSensitive)

Parameters:

userTimeZoneSensitive - - whether the returned DateFormat is in user's timezone

Returns:

the default date only DateFormat for date only object

getNowCalendar

public java.util.Calendar getNowCalendar()

Returns:

a now Calendar object

format

public java.lang.String format(java.math.BigDecimal bigDecimal)

Formats a BigDecimal into a local-sensitive String

Parameters:

bigDecimal - The BigDecimal value to format

Returns:

the formatted string

format

public java.lang.String format(java.math.BigDecimal bigDecimal,
                               boolean group,
                               boolean stripTrailingZeros)

Formats a BigDecimal into a local-sensitive String

Parameters:

bigDecimal - The BigDecimal value to format

Returns:

the formatted string

format

public java.lang.String format(java.math.BigDecimal bigDecimal,
                               boolean group)

Formats a BigDecimal into a local-sensitive String

Parameters:

bigDecimal - The BigDecimal value to format

group - Whether to show grouping or not

Returns:

the formatted string

parseBigDecimal

public java.math.BigDecimal parseBigDecimal(java.lang.String value)

Parses a locale-sensitive String into a BigDecimal

Parameters:

value - the String value

Returns:

BigDecimal parsed from value

getLocale

public java.util.Locale getLocale()

Returns:

the locale used to format and parse date time string by this object

getTimezone

public java.util.TimeZone getTimezone()

Return the time zone used to format and parse date time string by this object in user's time zone

Returns:

TimeZone

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

Set the user Time Zone. Used in Scheduler when the time zone from the user differs from the Schedule Plan Time Zone, but the date format needs to match the user formats (that may come from the DateFormatPolicy)

Parameters:

timeZone -

isRelDate

public boolean isRelDate(java.lang.String date)

isRelDate

public boolean isRelDate(java.lang.String date,
                         boolean dateonly)

parseTimestamp

public java.sql.Timestamp parseTimestamp(java.lang.String datetime,
                                         boolean userTimeZoneSensitive)

parseTimestamp

public java.sql.Timestamp parseTimestamp(java.lang.String datetime)

getLocaleForDateTime

public java.util.Locale getLocaleForDateTime()