com.ontimize.util.templates

Interface TemplateGenerator

All Known Implementing Classes:

AbstractTemplateGenerator, DocxTemplateGenerator, ODFTemplateGenerator, PdfTemplateGenerator, WordTemplateGenerator

public interface TemplateGenerator

Method Summary

Methods

Modifier and Type	Method and Description
File	createTemplate(Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages) Creates an empty template.
File	fillDocument(InputStream input, String nameFile, Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages) Fills the template
File	fillDocument(InputStream input, String nameFile, Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages, Hashtable valuesPivotTable)
File	fillDocument(String resource, Hashtable valuesDescriptions, Hashtable valuesTable, Hashtable valuesImages) Fills the specified template
File	fillDocument(String resource, Hashtable valuesDescriptions, Hashtable valuesTable, Hashtable valuesImages, Hashtable valuesPivotTable)
List	queryTemplateFields(File template) Creates a list with all data fields included in the template
List	queryTemplateFields(String template) Creates a list with all data fields included in the template
void	setCreateLabelsInTemplate(boolean createLabels)
void	setDateFormat(DateFormat df) Sets the date format to use in the dates of the document
void	setNumberFormat(NumberFormat nf) Sets the number format to use in the numeric values of the document
void	setShowTemplate(boolean show) Sets the value of the variable show.

Method Detail

fillDocument

File fillDocument(String resource,
                Hashtable valuesDescriptions,
                Hashtable valuesTable,
                Hashtable valuesImages)
                  throws Exception

Fills the specified template

Parameters:

resource - : Resource where the template is located.

valuesDescriptions - Values for the data fields

valuesTable - Table values

valuesImages - Image values

Returns:

Throws:

Exception

fillDocument

File fillDocument(String resource,
                Hashtable valuesDescriptions,
                Hashtable valuesTable,
                Hashtable valuesImages,
                Hashtable valuesPivotTable)
                  throws Exception

Throws:

Exception

fillDocument

File fillDocument(InputStream input,
                String nameFile,
                Hashtable fieldValues,
                Hashtable valuesTable,
                Hashtable valuesImages)
                  throws Exception

Fills the template

Parameters:

input - : Template to fill.

nameFile - : Name used to save the filled template

fieldValues - : This object contains the data field values to insert in the template. Keys must be the field names and values must have the data field values to insert.

valuesTable - : The object contains the table values to insert in the template. Each key must be the table entity name and value must be an EntityResult

valuesImages - : The object contains the image values to insert. Key must be the image field name and value must be the image data. The value could be an image object (Image), a BytesBlock or a File.

Returns:

Throws:

Exception

fillDocument

File fillDocument(InputStream input,
                String nameFile,
                Hashtable fieldValues,
                Hashtable valuesTable,
                Hashtable valuesImages,
                Hashtable valuesPivotTable)
                  throws Exception

Throws:

Exception

setDateFormat

void setDateFormat(DateFormat df)

Sets the date format to use in the dates of the document

Parameters:

df - Format

setNumberFormat

void setNumberFormat(NumberFormat nf)

Sets the number format to use in the numeric values of the document

Parameters:

nf -

setShowTemplate

void setShowTemplate(boolean show)

Sets the value of the variable show. When this variable takes the value "true", the template is shown to the user. Elsewhere, the template will not be shown

Parameters:

show -

setCreateLabelsInTemplate

void setCreateLabelsInTemplate(boolean createLabels)

createTemplate

File createTemplate(Hashtable fieldValues,
                  Hashtable valuesTable,
                  Hashtable valuesImages)
                    throws Exception

Creates an empty template.

Parameters:

fieldValues - : This object contains the data fields attributes and labels to show in the template

valuesTable - : The object contains the table information to insert in the template. This map must have the table entity name as key and the value must be other Hashtable with the columns attributes and names to show (column name - column label)

valuesImages - : The object contains information about the image fields which owns the form. This map contains the name of the image field (value) and its attribute (key)

Throws:

Exception

queryTemplateFields

List queryTemplateFields(String template)
                         throws Exception

Creates a list with all data fields included in the template

Parameters:

template - Template to query

Returns:

List with all data fields included in the template

Throws:

Exception

queryTemplateFields

List queryTemplateFields(File template)
                         throws Exception

Creates a list with all data fields included in the template

Parameters:

template - Template to query

Returns:

List with all data fields included in the template

Throws:

Exception