com.goldencode.p2j.reporting

Class Xpr2PdfWorker

java.lang.Object

com.goldencode.p2j.reporting.Xpr2PdfWorker

public class Xpr2PdfWorker
extends java.lang.Object

The object prepares the data structures required to build consistent Jasper report object and initiates the process of generating output PDF file via Jasper API.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DPI_DEFAULT Default DPI value for screen report.
static int	FONT_STYLE_BOLD Font style bold.
static int	FONT_STYLE_BOLD_ITALIC Font style bold and italic.
static int	FONT_STYLE_ITALIC Font style italic.
static int	FONT_STYLE_NORMAL Font style normal.
private java.util.Map<java.lang.String,java.lang.Object>	jspParameters Parameters for Jasper export.
private long	parameterCounter Variable to keep tracking the next parameter number.
private java.lang.String	pdfFileName The output PDF file name to generate.
private static java.util.Map<java.lang.String,java.lang.String[]>	pdfFontMap Map to match OS font prefix names to PDF generic font names.
private double	pixPerCol Row modifier to convert XPR helper character coords to pixel.
private double	pixPerRow Row modifier to convert XPR helper row coords to pixel.
private XprEntity	xprBaseInput The XPR base object to get all required info about objects to include in output.

Constructor Summary

Constructors

Constructor and Description
Xpr2PdfWorker(XprEntity xprBase, java.lang.String pdfName) Creates new instance of the object with the given file name to export.

Method Summary

Modifier and Type	Method and Description
boolean	export(boolean simpleUsage) Creates on the fly Jasper report and exports into PDF.
static java.lang.String	getMappedPdfFontName(java.lang.String fntName, int fntAttr) Maps the given OS dependent font name to OS independent PDF font.
private java.lang.String	getNewParameterName() Creates new unique parameter name for Jasper report.
private net.sf.jasperreports.engine.design.JasperDesign	makeJasperDesign(int pageNum) Creates on the fly Jasper report.
private void	setBarcodeInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand, XprObjBarcode objBarcodeToAdd, net.sf.jasperreports.engine.design.JasperDesign jspDesign) Adding barcode object to the given Jasper report band as next one.
private void	setImageInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand, XprObjImage objImageToAdd, net.sf.jasperreports.engine.design.JasperDesign jspDesign) Adding image object to the given Jasper report band as next one.
private void	setLineInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand, XprObjLine objLineToAdd) Adding line object to the given Jasper report band as next one.
private void	setObjectsInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand, java.util.List<XprObjBase> objectsToAdd, net.sf.jasperreports.engine.design.JasperDesign jspDesign) Adding different objects to the given Jasper report band keeping Z-order.
private void	setRectangleInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand, XprObjRectangle objRectangleToAdd, boolean isFilled) Adding line object to the given Jasper report band as next one.
private void	setTextInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand, XprObjText objTextToAdd, net.sf.jasperreports.engine.design.JasperDesign jspDesign) Adding text object to the given Jasper report band as next one.

Methods inherited from class java.lang.Object

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

Field Detail

FONT_STYLE_NORMAL

public static final int FONT_STYLE_NORMAL

Font style normal.

See Also:

Constant Field Values

FONT_STYLE_BOLD

public static final int FONT_STYLE_BOLD

Font style bold.

See Also:

Constant Field Values

FONT_STYLE_BOLD_ITALIC

public static final int FONT_STYLE_BOLD_ITALIC

Font style bold and italic.

See Also:

Constant Field Values

FONT_STYLE_ITALIC

public static final int FONT_STYLE_ITALIC

Font style italic.

See Also:

Constant Field Values

DPI_DEFAULT

public static final int DPI_DEFAULT

Default DPI value for screen report.

See Also:

Constant Field Values

xprBaseInput

private XprEntity xprBaseInput

The XPR base object to get all required info about objects to include in output.

pdfFileName

private java.lang.String pdfFileName

The output PDF file name to generate.

jspParameters

private java.util.Map<java.lang.String,java.lang.Object> jspParameters

Parameters for Jasper export.

pixPerRow

private double pixPerRow

Row modifier to convert XPR helper row coords to pixel.

pixPerCol

private double pixPerCol

Row modifier to convert XPR helper character coords to pixel.

parameterCounter

private long parameterCounter

Variable to keep tracking the next parameter number.

pdfFontMap

private static java.util.Map<java.lang.String,java.lang.String[]> pdfFontMap

Map to match OS font prefix names to PDF generic font names.

Constructor Detail

Xpr2PdfWorker

public Xpr2PdfWorker(XprEntity xprBase,
                     java.lang.String pdfName)

Creates new instance of the object with the given file name to export.

Parameters:

xprBase - The XPR object to be the base for Jasper report creation.

pdfName - The PDF file object to export.

Method Detail

getMappedPdfFontName

public static java.lang.String getMappedPdfFontName(java.lang.String fntName,
                                                    int fntAttr)

Maps the given OS dependent font name to OS independent PDF font.

Parameters:

fntName - The name of the OS dependent font name to be mapped to PDF font.

fntAttr - The desired font attributes, normal, bold or italic.

Returns:

The PDF font name to use or NULL if mapping is not possible.

export

public boolean export(boolean simpleUsage)

Creates on the fly Jasper report and exports into PDF.

Parameters:

simpleUsage - TRUE means simple using as standalone application for debugging.

Returns:

TRUE if success, FALSE otherwise.

makeJasperDesign

private net.sf.jasperreports.engine.design.JasperDesign makeJasperDesign(int pageNum)

Creates on the fly Jasper report.

Parameters:

pageNum - 0 based page number to prepare on the fly report.

Returns:

jasper design object for current XPR data.

getNewParameterName

private java.lang.String getNewParameterName()

Creates new unique parameter name for Jasper report.

Returns:

jasper design parameter name.

setObjectsInBand

private void setObjectsInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand,
                              java.util.List<XprObjBase> objectsToAdd,
                              net.sf.jasperreports.engine.design.JasperDesign jspDesign)

Adding different objects to the given Jasper report band keeping Z-order.

Parameters:

objBand - The Jasper report band to prepare.

objectsToAdd - The list of objects to add.

jspDesign - The current design in use.

setLineInBand

private void setLineInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand,
                           XprObjLine objLineToAdd)

Adding line object to the given Jasper report band as next one.

Parameters:

objBand - The Jasper report band to prepare.

objLineToAdd - The line object to add.

setRectangleInBand

private void setRectangleInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand,
                                XprObjRectangle objRectangleToAdd,
                                boolean isFilled)

Adding line object to the given Jasper report band as next one.

Parameters:

objBand - The Jasper report band to prepare.

objRectangleToAdd - The rectangle object to add.

isFilled - TRUE for filled recteangle, FALSE for frame.

setTextInBand

private void setTextInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand,
                           XprObjText objTextToAdd,
                           net.sf.jasperreports.engine.design.JasperDesign jspDesign)

Adding text object to the given Jasper report band as next one.

Parameters:

objBand - The Jasper report band to prepare.

objTextToAdd - The text object to add.

jspDesign - The current design in use.

setImageInBand

private void setImageInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand,
                            XprObjImage objImageToAdd,
                            net.sf.jasperreports.engine.design.JasperDesign jspDesign)

Adding image object to the given Jasper report band as next one.

Parameters:

objBand - The Jasper report band to prepare.

objImageToAdd - The image object to add.

jspDesign - The current design in use.

setBarcodeInBand

private void setBarcodeInBand(net.sf.jasperreports.engine.design.JRDesignBand objBand,
                              XprObjBarcode objBarcodeToAdd,
                              net.sf.jasperreports.engine.design.JasperDesign jspDesign)

Adding barcode object to the given Jasper report band as next one.

Parameters:

objBand - The Jasper report band to prepare.

objBarcodeToAdd - The barcode object to add.

jspDesign - The current design in use.