org.egov.infra.reporting.util

Class ReportUtil

java.lang.Object

org.egov.infra.reporting.util.ReportUtil

public final class ReportUtil
extends Object

Provides utility methods related to reports

Method Summary

Modifier and Type	Method and Description
static Date	add(Date inputDate, int addType, int addAmount) Adds given number of days/months/years to given date and returns the resulting date
static String	amountInWords(BigDecimal amount) Converts given amount to words with default decimal precision of 2.
static String	cancelledWatermarkAbsolutePath() Gives the absolute path of the 'CANCELLED' Watermark image
static Object	fetchFromDBSql(Connection connection, String sqlQuery) Executes given SQL query (which is expected to return a single object) and returns the output.
static String	formatNumber(BigDecimal number, int fractionDigits, boolean useGrouping) Formats a given number with given number of fraction digits e.g.
static String	getCityName()
static Date	getDate(int year, int month, int date)
static InputStream	getImageAsStream(String imageName) Returns input stream for given image file.
static InputStream	getTemplateAsStream(String templateName) Returns input stream for given report template.
static Properties	loadReportConfig() Loads the report configuration file from classpath (/config/reports.properties)
static String	logoBasePath() Gives the absolute path of the logo image
static Date	now()
static Date	today()
static Date	tomorrow()

Methods inherited from class java.lang.Object

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

Method Detail

getImageAsStream

public static InputStream getImageAsStream(String imageName)

Returns input stream for given image file. First checks in the custom location (/custom/reports/images/). If not found, tries the product location (/reports/images/)

Parameters:

imageName - Name of image to be read

Returns:

Input stream for given image file

getCityName

public static String getCityName()

getTemplateAsStream

public static InputStream getTemplateAsStream(String templateName)

Returns input stream for given report template. First checks in the custom location (/custom/reports/templates/). If not found, tries the product location (/reports/templates/)

Parameters:

templateName - Report template to be read

Returns:

Input stream for given report template

loadReportConfig

public static Properties loadReportConfig()

Loads the report configuration file from classpath (/config/reports.properties)

Returns:

the Properties object created from the configuration file

fetchFromDBSql

public static Object fetchFromDBSql(Connection connection,
                                    String sqlQuery)
                             throws SQLException

Executes given SQL query (which is expected to return a single object) and returns the output. Returns null if query doesn't fetch any data.

Parameters:

connection - Connection to be used for executing the query. Can be passed as $P{REPORT_CONNECTION} in case of a jasper report

sqlQuery - Query to be executed to get the data

Returns:

Output of the query

Throws:

SQLException

getDate

public static Date getDate(int year,
                           int month,
                           int date)

Parameters:

year -

month -

date -

Returns:

date object representing given year, month and date

today

public static Date today()

Returns:

Date object representing today

now

public static Date now()

Returns:

Date object representing today

tomorrow

public static Date tomorrow()

Returns:

Date object representing tomorrow

add

public static Date add(Date inputDate,
                       int addType,
                       int addAmount)

Adds given number of days/months/years to given date and returns the resulting date

Parameters:

inputDate - Input date

addType - type to be added (Calendar.DAY_OF_MONTH/Calendar.MONTH/Calendar.YEAR)

addAmount - Number of days/months/years to be added to the input date

Returns:

Date after adding given number of days/months/years to the input date

amountInWords

public static String amountInWords(BigDecimal amount)

Converts given amount to words with default decimal precision of 2.

Parameters:

amount - Amount to be converted to words

Returns:

The amount in words with default decimal precision of 2.

formatNumber

public static String formatNumber(BigDecimal number,
                                  int fractionDigits,
                                  boolean useGrouping)

Formats a given number with given number of fraction digits
e.g. formatNumber(1000, 2, false) will return 1000.00
formatNumber(1000, 2, true) will return 1,000.00

Parameters:

number - The number to be formatted

fractionDigits - Number of fraction digits to be used for formatting

useGrouping - Flag indicating whether grouping is to be used while formatting the number

Returns:

Formatted number with given number of fraction digits

logoBasePath

public static String logoBasePath()

Gives the absolute path of the logo image

Returns:

absolute path of the logo image

cancelledWatermarkAbsolutePath

public static String cancelledWatermarkAbsolutePath()

Gives the absolute path of the 'CANCELLED' Watermark image

Returns:

absolute path of the 'CANCELLED' Watermark image