com.whitestein.lsps.stdlib.function

Class PdfFunctionsImpl

java.lang.Object

com.whitestein.lsps.stdlib.function.PdfFunctionsImpl

All Implemented Interfaces:

PdfFunctions

@PermitAll
public class PdfFunctionsImpl
extends java.lang.Object
implements PdfFunctions

PDF utility functions implementation.

Constructor Summary

Constructors

Constructor and Description
PdfFunctionsImpl()

Method Summary

Modifier and Type	Method and Description
RecordHolder	fillPdfForm(ExecutionContext context, RecordHolder pdfInput, java.lang.String fileName, MapHolder values) Fills a given PDF form.
BinaryHolder	fillPdfTemplate(ExecutionContext context, BinaryHolder pdfTemplate, BinaryHolder fdfDocument) Creates a new PDF document from a template.
BinaryHolder	fillPdfTemplate(ExecutionContext context, BinaryHolder pdfTemplate, MapHolder values) Creates a new PDF document from a template.
BinaryHolder	fillXfaPdfTemplate(ExecutionContext context, BinaryHolder xfaTemplate, RecordHolder data) Creates a new PDF document from the XFA template.
BinaryHolder	fillXfaPdfTemplate(ExecutionContext context, BinaryHolder xfaTemplate, java.lang.String xml) Creates a new PDF document from the XFA template.

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfFunctionsImpl

public PdfFunctionsImpl()

Method Detail

fillPdfForm

public RecordHolder fillPdfForm(ExecutionContext context,
                                RecordHolder pdfInput,
                                java.lang.String fileName,
                                MapHolder values)
                         throws ErrorException

Description copied from interface: PdfFunctions

Fills a given PDF form.

Specified by:

fillPdfForm in interface PdfFunctions

Parameters:

context - the LSPS execution context

pdfInput - PDF form as a BinaryHandle record

fileName - a file name of the created output BinaryHandle

values - a map with PDF form field names as keys

Returns:

the created BinaryHandle record

Throws:

ErrorException

fillPdfTemplate

public BinaryHolder fillPdfTemplate(ExecutionContext context,
                                    BinaryHolder pdfTemplate,
                                    MapHolder values)
                             throws ErrorException

Description copied from interface: PdfFunctions

Creates a new PDF document from a template. It fills the template with data from the values map. The keys of the map represent the field names.

Specified by:

fillPdfTemplate in interface PdfFunctions

Parameters:

context - the execution context

pdfTemplate - a PDF template

values - the values for the form fields

Returns:

a binary holder representing the produced PDF document.

Throws:

ErrorException - If error occurs during the creation of the PDF document

fillPdfTemplate

public BinaryHolder fillPdfTemplate(ExecutionContext context,
                                    BinaryHolder pdfTemplate,
                                    BinaryHolder fdfDocument)
                             throws ErrorException

Description copied from interface: PdfFunctions

Creates a new PDF document from a template. It fills the template with data from the FDF document.

Specified by:

fillPdfTemplate in interface PdfFunctions

Parameters:

context - the execution context

pdfTemplate - a PDF template

fdfDocument - the values for the form fields

Returns:

a binary holder representing the produced PDF document.

Throws:

ErrorException - If error occurs during the creation of the PDF document

fillXfaPdfTemplate

public BinaryHolder fillXfaPdfTemplate(ExecutionContext context,
                                       BinaryHolder xfaTemplate,
                                       java.lang.String xml)
                                throws ErrorException

Description copied from interface: PdfFunctions

Creates a new PDF document from the XFA template. It fills the template with data specified by the xml. The xml must conform to the XSD specified by the template.

Specified by:

fillXfaPdfTemplate in interface PdfFunctions

Parameters:

context - the execution context

xfaTemplate - the PDF template with XFA controls

xml - the data for the template

Returns:

a binary holder representing the produced PDF document.

Throws:

ErrorException

fillXfaPdfTemplate

public BinaryHolder fillXfaPdfTemplate(ExecutionContext context,
                                       BinaryHolder xfaTemplate,
                                       RecordHolder data)
                                throws ErrorException

Description copied from interface: PdfFunctions

Creates a new PDF document from the XFA template. It fills the template with the data record. The type of populated record must specify the XML mapping that conforms to the XML schema required by the template.

Specified by:

fillXfaPdfTemplate in interface PdfFunctions

Parameters:

context - the execution context

xfaTemplate - the PDF template with XFA controls

data - the data for the template

Returns:

a binary holder representing the produced PDF document.

Throws:

ErrorException