sapphire.report

Class JasperReportScriptlet

java.lang.Object

JRDefaultScriptlet

sapphire.report.JasperReportScriptlet

public class JasperReportScriptlet
extends JRDefaultScriptlet

Default JasperScriplet class for sapphire jasper report. Providing sapphire formatting according to sapphire user's locale, timezone and language profile

Constructor Summary

Constructors

Constructor and Description
JasperReportScriptlet()

Method Summary

Modifier and Type	Method and Description
void	beforeDetailEval() Sapphire implementation of JRDefaultScriptlet.
void	beforeReportInit() Sapphire implementation of JRDefaultScriptlet.
java.lang.String	format(java.lang.Object valueobject) Provide default sapphire formatting support
java.lang.String	formatDataEntryDisplay(java.lang.String displayvalue, java.lang.String datatype, java.lang.Object transformvalue, java.lang.Object transformdt, java.lang.String displayformat, java.lang.String displayvalueformat) Provide sapphire formatting support for dataentry displayvalue
java.lang.String	formatDate(java.util.Calendar datetime) Provide sapphire date time formatting support
java.lang.String	formatDate(java.util.Calendar datetime, int datePattern, int timePattern) Provide sapphire date time formatting support
java.lang.String	formatDate(java.util.Date datetime) Provide sapphire date time formatting support
java.lang.String	formatDate(java.util.Date datetime, int datePattern, int timePattern) Provide sapphire date time formatting support
java.lang.String	formatDate(java.sql.Timestamp datetime) Provide sapphire date time formatting support
java.lang.String	formatDate(java.sql.Timestamp datetime, int datePattern, int timePattern) Provide sapphire date time formatting support
java.lang.String	formatDateOnly(java.util.Calendar datetime) Provide sapphire date only formatting support
java.lang.String	formatDateOnly(java.util.Calendar datetime, int datePattern) Provide sapphire date time formatting support
java.lang.String	formatDateOnly(java.util.Date datetime) Provide sapphire date time formatting support
java.lang.String	formatDateOnly(java.util.Date datetime, int datePattern) Provide sapphire date time formatting support
java.lang.String	formatDateOnly(java.sql.Timestamp datetime) Provide sapphire date time formatting support
java.lang.String	formatDateOnly(java.sql.Timestamp datetime, int datePattern) Provide sapphire date time formatting support
java.lang.String	formatNumber(java.math.BigDecimal num) Provide sapphire number formatting support
java.lang.String	formatNumber(java.math.BigDecimal num, boolean group) Provide sapphire number formatting support
java.io.ByteArrayInputStream	getAttachment(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, int attachmentNum, java.lang.String connectonId) Returns Bytes array of attachment
java.io.ByteArrayInputStream	getAttachment(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, java.lang.String attachmentClass, java.lang.String connectonId) Returns Bytes array of attachment
ConnectionInfo	getConnectionInfo()
java.util.HashMap	getFieldValueMap()
static java.util.Calendar	getOffsetDate(java.sql.Timestamp offsetfromDt, java.lang.String periodUnit, java.math.BigDecimal period) Provide date calculation support with adding or reducing the offsetfromDt with the input period unit.
java.lang.String	text(java.lang.String key) Provide static text lookup support.
java.lang.String	translate(java.lang.String text) Provide sapphire translation support
java.lang.String	translate(java.lang.String text, java.lang.String context) Provide sapphire translation support
java.lang.String	translate(java.lang.String text, java.lang.String context, java.lang.String languageid) Provide sapphire translation support

Methods inherited from class java.lang.Object

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

Constructor Detail

JasperReportScriptlet

public JasperReportScriptlet()

Method Detail

getFieldValueMap

public java.util.HashMap getFieldValueMap()

getConnectionInfo

public ConnectionInfo getConnectionInfo()

beforeReportInit

public void beforeReportInit()

Sapphire implementation of JRDefaultScriptlet. Subclass should call super.beforeReportInit if providing own implementation.

beforeDetailEval

public void beforeDetailEval()

Sapphire implementation of JRDefaultScriptlet. Subclass should call super.beforeDetailEval if providing own implementation.

translate

public java.lang.String translate(java.lang.String text)

Provide sapphire translation support

Parameters:

text - original text to be translated

Returns:

the translate text.

translate

public java.lang.String translate(java.lang.String text,
                                  java.lang.String context)

Provide sapphire translation support

Parameters:

text - original text to be translated

context - the context under which the text to be translated

Returns:

the translate text.

translate

public java.lang.String translate(java.lang.String text,
                                  java.lang.String context,
                                  java.lang.String languageid)

Provide sapphire translation support

Parameters:

text - original text to be translated

context - the context under which the text to be translated

languageid - the languageid to which the text to be translated

Returns:

the translate text.

formatDate

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

Provide sapphire date time formatting support

Parameters:

datetime - calendar object to be formatted

Returns:

the formatted string using DateFormat.MEDIUM for both date and time.

formatDateOnly

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

Provide sapphire date only formatting support

Parameters:

datetime - calendar object to be formatted

Returns:

the formatted string using DateFormat.MEDIUM for the date.

formatDateOnly

public java.lang.String formatDateOnly(java.util.Calendar datetime,
                                       int datePattern)

Provide sapphire date time formatting support

Parameters:

datetime - calendar object to be formatted

datePattern - ( DateFormat.MEDIUM, DateFormat.SHORT, DateFormat.LONG )

Returns:

the formatted string for the specified datePattern and timePattern.

formatDate

public java.lang.String formatDate(java.util.Calendar datetime,
                                   int datePattern,
                                   int timePattern)

Provide sapphire date time formatting support

Parameters:

datetime - calendar object to be formatted

datePattern - ( DateFormat.MEDIUM, DateFormat.SHORT, DateFormat.LONG )

timePattern -

Returns:

the formatted string for the specified datePattern and timePattern.

formatDateOnly

public java.lang.String formatDateOnly(java.util.Date datetime)

Provide sapphire date time formatting support

Parameters:

datetime - Date object to be formatted

Returns:

the formatted string using DateFormat.MEDIUM for both date and time.

formatDate

public java.lang.String formatDate(java.util.Date datetime)

Provide sapphire date time formatting support

Parameters:

datetime - Date object to be formatted

Returns:

the formatted string using DateFormat.MEDIUM for both date and time.

formatDateOnly

public java.lang.String formatDateOnly(java.util.Date datetime,
                                       int datePattern)

Provide sapphire date time formatting support

Parameters:

datetime - Date object to be formatted

datePattern -

Returns:

the formatted string for the specified datePattern.

formatDate

public java.lang.String formatDate(java.util.Date datetime,
                                   int datePattern,
                                   int timePattern)

Provide sapphire date time formatting support

Parameters:

datetime - Date object to be formatted

datePattern -

timePattern -

Returns:

the formatted string for the specified datePattern and timePattern.

formatDateOnly

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

Provide sapphire date time formatting support

Parameters:

datetime - java.sql.Timestamp object to be formatted

Returns:

the formatted string using DateFormat.MEDIUM for both date and time.

formatDate

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

Provide sapphire date time formatting support

Parameters:

datetime - java.sql.Timestamp object to be formatted

Returns:

the formatted string using DateFormat.MEDIUM for both date and time.

formatDateOnly

public java.lang.String formatDateOnly(java.sql.Timestamp datetime,
                                       int datePattern)

Provide sapphire date time formatting support

Parameters:

datetime - java.sql.Timestamp object to be formatted

datePattern -

Returns:

the formatted string for the specified datePattern.

formatDate

public java.lang.String formatDate(java.sql.Timestamp datetime,
                                   int datePattern,
                                   int timePattern)

Provide sapphire date time formatting support

Parameters:

datetime - java.sql.Timestamp object to be formatted

datePattern -

timePattern -

Returns:

the formatted string for the specified datePattern and timePattern.

formatNumber

public java.lang.String formatNumber(java.math.BigDecimal num)

Provide sapphire number formatting support

Parameters:

num - BigDecimal object to be formatted

Returns:

the formatted string with no group separator.

formatNumber

public java.lang.String formatNumber(java.math.BigDecimal num,
                                     boolean group)

Provide sapphire number formatting support

Parameters:

num - BigDecimal object to be formatted

group - whether to use group separator

Returns:

the formatted string with no group separator.

format

public java.lang.String format(java.lang.Object valueobject)

Provide default sapphire formatting support

Parameters:

valueobject - Object to be formatted

Returns:

the formatted string.

formatDataEntryDisplay

public java.lang.String formatDataEntryDisplay(java.lang.String displayvalue,
                                               java.lang.String datatype,
                                               java.lang.Object transformvalue,
                                               java.lang.Object transformdt,
                                               java.lang.String displayformat,
                                               java.lang.String displayvalueformat)

Provide sapphire formatting support for dataentry displayvalue

Parameters:

displayvalue - the displayvalue field in the sdidataitem table

datatype - the displayvalue field in the sdidataitem table

transformvalue - the transformvalue field in the sdidataitem table

transformdt - the transformdt field in the sdidataitem table

displayformat - the displayformat field in the sdidataitem table

displayvalueformat - the displayvalueformat field in the sdidataitem table

Returns:

the formatted string for the specified displayvalueformat(if exist) or displayformat.

text

public java.lang.String text(java.lang.String key)

Provide static text lookup support. The key and value texts are retrieved from file reporttext.props(UTF-8 encoding) from report root folder or report root/OOB folder. Update to the reporttext.props file requires server restart.

Parameters:

key - the key for the text.

Returns:

the value text String. If key not found the original key is returned.

getOffsetDate

public static java.util.Calendar getOffsetDate(java.sql.Timestamp offsetfromDt,
                                               java.lang.String periodUnit,
                                               java.math.BigDecimal period)

Provide date calculation support with adding or reducing the offsetfromDt with the input period unit.

Parameters:

offsetfromDt - java.sql.Timestamp the original date to calculate from.

periodUnit - String the period offset Unit to use to calculate. Valid periodUnits are "Minutes", "Hours", "Days", "Weeks", "Months" and "Years".

period - BigDecimal the period offset to calculate.

Returns:

the calculated java.util.Calendar object in system timezone. Returns null if offsetfromDt is null or periodUnit is Invalid. Returns converted Calendar from offsetfromDt if period is null.

getAttachment

public java.io.ByteArrayInputStream getAttachment(java.lang.String sdcid,
                                                  java.lang.String keyid1,
                                                  java.lang.String keyid2,
                                                  java.lang.String keyid3,
                                                  int attachmentNum,
                                                  java.lang.String connectonId)

Returns Bytes array of attachment

Parameters:

sdcid -

keyid1 -

keyid2 -

keyid3 -

attachmentNum -

connectonId -

Returns:

getAttachment

public java.io.ByteArrayInputStream getAttachment(java.lang.String sdcid,
                                                  java.lang.String keyid1,
                                                  java.lang.String keyid2,
                                                  java.lang.String keyid3,
                                                  java.lang.String attachmentClass,
                                                  java.lang.String connectonId)

Returns Bytes array of attachment

Parameters:

sdcid -

keyid1 -

keyid2 -

keyid3 -

attachmentClass -

connectonId -

Returns: