com.ontimize.util.templates

Class DocxTemplateGenerator

java.lang.Object

com.ontimize.util.templates.AbstractTemplateGenerator

com.ontimize.util.templates.DocxTemplateGenerator

All Implemented Interfaces:

TemplateGenerator

public class DocxTemplateGenerator
extends AbstractTemplateGenerator

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE_PLACEHOLDER
static String	OPEN_PLACEHOLDER
protected boolean	showTemplate

Fields inherited from class com.ontimize.util.templates.AbstractTemplateGenerator

createLabelsInTemplate, dateFormat, DEBUG, numberFormat

Constructor Summary

Constructors

Constructor and Description
DocxTemplateGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addBorders(org.docx4j.wml.Tbl table) Add single borders to the table.
protected static void	addTableCell(org.docx4j.wml.Tr tableRow, String content, org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mainDocument) Add content to a cell, and then add it to the row
protected static Vector<String>	createFieldString(Hashtable fieldHashtable) Build a Vector of singleString with all of the fields data in the Hahstable fieldHashtable.
protected static Vector<org.docx4j.wml.Tbl>	createImagesField(Hashtable valuesImages, org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mainDocument) Return a Vector of Tbl to store the image placeholder
protected static org.docx4j.wml.Tbl	createSingleTable(String tableObjectKey, Hashtable valuesSingleTable, org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mainDocument) Create a single table with two rows.
protected static Vector<org.docx4j.wml.Tbl>	createTablesObject(Hashtable valuesTable, org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mainDocument) Create a Vector of single Tbl table, which the data stored in valuesTable.
File	createTemplate(Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages) The DocxTemplateGenerator adds the possibility to put the fields in the template in a specified order.
protected static String	entityAsPlaceholder(String entity) Return the entity name of a table as placeholder
File	fillDocument(InputStream input, String nameFile, Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages, Hashtable valuesPivotTable) Populate the templates with the information given in the Hashtables.
protected static void	findAndReplaceDocument(File templateFilled, Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages, Hashtable valuesPivotTable) Find and replace the placeholders of the template with the data given in the Hashtable
static void	findAndReplaceFields(org.docx4j.openpackaging.packages.WordprocessingMLPackage doc, Hashtable fieldValues) Find and replace the placeholder of an field in template.
protected static void	findAndReplaceImages(org.docx4j.openpackaging.packages.WordprocessingMLPackage mlp, Hashtable valuesImages) Find and replace the placeholder of an image in template.
protected static void	findAndReplaceTables(org.docx4j.openpackaging.packages.WordprocessingMLPackage mlp, Hashtable valuesTable) Find and replace the tables in template which have reference an entity.
protected static void	generateDocxTemplate(File template, Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages) Create a *.docx document template
static List<Object>	getElements(Object obj, Class<?> classFinder) Get a List of elements of the class specified by classFinder, inside the obj.
protected static org.docx4j.dml.wordprocessingDrawing.Inline	inlineImage(byte[] ba, org.docx4j.openpackaging.packages.WordprocessingMLPackage mlp, String filenameHint) Creates an Inline image.
protected static org.docx4j.wml.P	paragraphContentImage(org.docx4j.dml.wordprocessingDrawing.Inline createInlineImage) Create a P with the Inline image received by parameter.
protected static void	populateTbl(org.docx4j.wml.Tbl entityTables, EntityResult actualValues, int indexRowEntityPlaceholder, org.docx4j.openpackaging.packages.WordprocessingMLPackage mlp) Populate the table which references a Table in the Ontimize form.
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	setShowTemplate(boolean show) Set if the template will be open after its creation
protected Hashtable	translateDotFields(Hashtable values) Change dot character "." on keys with "ç" character
static Hashtable	translateToPatternFields(Hashtable values) Change the form attributes keys for placeholder keys pattern

Methods inherited from class com.ontimize.util.templates.AbstractTemplateGenerator

calculateRecordCount, containsHashtableValue, createFileFieldData, createImageDataFile, createTableDataDefinition, createTableDataDefinition, createTableDataFile, createTableDataFile, exportFieldData, exportFieldData, exportTableData, fillDocument, fillDocument, fillDocument, getKeysOrder, getScreenPoints, parseNumber, savePngImageFile, setCreateLabelsInTemplate, setDateFormat, setNumberFormat, transformFieldData, transformFieldData

Methods inherited from class java.lang.Object

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

Field Detail

OPEN_PLACEHOLDER

public static final String OPEN_PLACEHOLDER

See Also:

Constant Field Values

CLOSE_PLACEHOLDER

public static final String CLOSE_PLACEHOLDER

See Also:

Constant Field Values

showTemplate

protected boolean showTemplate

Constructor Detail

DocxTemplateGenerator

public DocxTemplateGenerator()

Method Detail

fillDocument

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

Populate the templates with the information given in the Hashtables.

Parameters:

input - : An InputStream from the original template, which will remain. unaltered

nameFile - : The name of the new *.docx document, with extension included.

fieldValues - : A Hashtable with the data used in the fields of the form. As key, the attribute to replace and as value, their replace.

valuesTable - : A Hashtable with the data used in the tables of the form. As key, the entity name of the table, as value, the EntityResult will all table data.

valuesImages - : A Hashtable with the images in the form. As key, the attribute to replace and as value, their image replace (like a BytesBlock or a BufferedImage)

valuesPivotTable - : A Hashtable of pivots table (NOT USED)

Throws:

Exception

findAndReplaceDocument

protected static void findAndReplaceDocument(File templateFilled,
                          Hashtable fieldValues,
                          Hashtable valuesTable,
                          Hashtable valuesImages,
                          Hashtable valuesPivotTable)
                                      throws Exception

Find and replace the placeholders of the template with the data given in the Hashtable

Parameters:

templateFilled - : The File of template to fill.

fieldValues - : A Hashtable with the data used in the fields of the form. As key, the placeholder to replace and as value, their replace.

valuesTable - : A Hashtable with the data used in the tables of the form. As key, the entity name of the table, as value, the EntityResult will all table data.

valuesImages - : A Hashtable with the images in the form. As key, the placeholder to replace and as value, their image replace (like a BytesBlock or a BufferedImage)

valuesPivotTable - : A Hashtable of pivots table (NOT USED)

Throws:

Exception

findAndReplaceTables

protected static void findAndReplaceTables(org.docx4j.openpackaging.packages.WordprocessingMLPackage mlp,
                        Hashtable valuesTable)

Find and replace the tables in template which have reference an entity.

Parameters:

mlp - : The WordprocessingMLPackage obtained from load the template file.

valuesTable - : A Hashtable with the data used in the tables of the form. As key, the entity name of the table, as value, the EntityResult will all table data.

populateTbl

protected static void populateTbl(org.docx4j.wml.Tbl entityTables,
               EntityResult actualValues,
               int indexRowEntityPlaceholder,
               org.docx4j.openpackaging.packages.WordprocessingMLPackage mlp)

Populate the table which references a Table in the Ontimize form.

Parameters:

entityTables - : The Tbl WITHOUT the row that indicates its entity.

actualValues - : The EntityResult of table data.

indexRowEntityPlaceholder - : The index of row entity placeholder BEFORE its removal

mlp - : The WordprocessingMLPackage obtained from load the template file.

entityAsPlaceholder

protected static String entityAsPlaceholder(String entity)

Return the entity name of a table as placeholder

Parameters:

entity - : The entity name String

Returns:

The entity name placeholder.

findAndReplaceImages

protected static void findAndReplaceImages(org.docx4j.openpackaging.packages.WordprocessingMLPackage mlp,
                        Hashtable valuesImages)
                                    throws Exception

Find and replace the placeholder of an image in template.

Parameters:

mlp - : The WordprocessingMLPackage obtained from load the template file.

valuesTable - : A Hashtable with the images in the form. As key, the placeholder to replace and as value, their image replace (like a BytesBlock or a BufferedImage)

Throws:

Exception

paragraphContentImage

protected static org.docx4j.wml.P paragraphContentImage(org.docx4j.dml.wordprocessingDrawing.Inline createInlineImage)

Create a P with the Inline image received by parameter.

Parameters:

createInlineImage - : An Inline image to be sorrounded with a P

Returns:

A P paragraph with the image

inlineImage

protected static org.docx4j.dml.wordprocessingDrawing.Inline inlineImage(byte[] ba,
                                                      org.docx4j.openpackaging.packages.WordprocessingMLPackage mlp,
                                                      String filenameHint)
                                                                  throws Exception

Creates an Inline image.

Parameters:

ba - : A bytes array from the image

mlp - : A WordprocessingMLPackage from load a template File

filenameHint - : A String with the image hint, for example, the original name

Returns:

An Inline object built with the bytes array of an image

Throws:

Exception

getElements

public static List<Object> getElements(Object obj,
                       Class<?> classFinder)

Get a List of elements of the class specified by classFinder, inside the obj.

Parameters:

obj - : The source object.

classFinder - : The Class of the object to search.

Returns:

A List with the objects of type classFinder inside obj

findAndReplaceFields

public static void findAndReplaceFields(org.docx4j.openpackaging.packages.WordprocessingMLPackage doc,
                        Hashtable fieldValues)

Find and replace the placeholder of an field in template.

Parameters:

doc - : The WordprocessingMLPackage obtained from load the template file.

fieldValues - : A Hashtable with the images in the form. As key, the placeholder to replace and as value, their replace.

setShowTemplate

public void setShowTemplate(boolean show)

Set if the template will be open after its creation

Parameters:

show - Boolean that indicates if the template will be open after its creation or not.

createTemplate

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

The DocxTemplateGenerator adds the possibility to put the fields in the template in a specified order.
The parameter fieldValues can be a EntityResult object, and use the EntityResult.setColumnOrder(List) method to specified the order of the fields in the 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)

Returns:

The template file.

Throws:

Exception

queryTemplateFields

public List queryTemplateFields(File template)
                         throws Exception

Description copied from interface: TemplateGenerator

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

public List queryTemplateFields(String template)
                         throws Exception

Description copied from interface: TemplateGenerator

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

translateDotFields

protected Hashtable translateDotFields(Hashtable values)

Change dot character "." on keys with "ç" character

Parameters:

values - : Original Hashtable

Returns:

A Hashtable with the key field translated

translateToPatternFields

public static Hashtable translateToPatternFields(Hashtable values)

Change the form attributes keys for placeholder keys pattern

Parameters:

values -

Returns:

A Hashtable with the key field translated

generateDocxTemplate

protected static void generateDocxTemplate(File template,
                        Hashtable fieldValues,
                        Hashtable valuesTable,
                        Hashtable valuesImages)
                                    throws Exception

Create a *.docx document template

Parameters:

template - The file template

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

createImagesField

protected static Vector<org.docx4j.wml.Tbl> createImagesField(Hashtable valuesImages,
                                           org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mainDocument)

Return a Vector of Tbl to store the image placeholder

Parameters:

valuesImages - : A Hashtable with the images in the form. As key, the placeholder to replace and as value, their image replace (like a BytesBlock or a BufferedImage)

mainDocument - : A MainDocumentPart of the template file.

Returns:

a Vector of Tbl which contents the placeholder of the image.

createFieldString

protected static Vector<String> createFieldString(Hashtable fieldHashtable)

Build a Vector of singleString with all of the fields data in the Hahstable fieldHashtable. This map stored the label of the field as value and the attribute of the field as key

Parameters:

fieldHashtable - : The field value data

Returns:

A Vector of String with all of the field data stored in the fieldHashtable

createSingleTable

protected static org.docx4j.wml.Tbl createSingleTable(String tableObjectKey,
                                   Hashtable valuesSingleTable,
                                   org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mainDocument)

Create a single table with two rows. A header row, that has the name of the columns, and a body row, with the attribute of columns

Parameters:

tableObjectKey -

valuesSingleTable - : A hashtable which has the name of the columns ad its respective attributes.

mainDocument - : The MainDocumentPart of the template, where the table will be in.

Returns:

A single table with the built with the valuesSingleTable data

createTablesObject

protected static Vector<org.docx4j.wml.Tbl> createTablesObject(Hashtable valuesTable,
                                            org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mainDocument)

Create a Vector of single Tbl table, which the data stored in valuesTable. See #createSingleTable(Hashtable, MainDocumentPart)

Parameters:

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)

mainDocument - : The MainDocumentPart of the template, where the table will be in.

Returns:

A Vector of Tbl tables.

addTableCell

protected static void addTableCell(org.docx4j.wml.Tr tableRow,
                String content,
                org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart mainDocument)

Add content to a cell, and then add it to the row

Parameters:

tableRow - The table row where the cell will be added

content - The content of the cell

mainDocument - : The MainDocumentPart of the template, where the cell will be in.

addBorders

protected static void addBorders(org.docx4j.wml.Tbl table)

Add single borders to the table.

Parameters:

table - : The source table