com.ontimize.util.templates

Class AbstractTemplateGenerator

java.lang.Object

com.ontimize.util.templates.AbstractTemplateGenerator

All Implemented Interfaces:

TemplateGenerator

Direct Known Subclasses:

DocxTemplateGenerator, ODFTemplateGenerator, PdfTemplateGenerator, WordTemplateGenerator

public abstract class AbstractTemplateGenerator
extends Object
implements TemplateGenerator

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	createLabelsInTemplate Variable used to show labels in the template or not, if createLabelsInTemplate is false only the bookmarks are added to the template, without any label
protected DateFormat	dateFormat
static boolean	DEBUG
protected NumberFormat	numberFormat

Constructor Summary

Constructors

Constructor and Description
AbstractTemplateGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
static int	calculateRecordCount(Hashtable data) Calculates the number of data rows.
static boolean	containsHashtableValue(Hashtable data) Returns true if some of the values in the input parameter is another hashtable
static File	createFileFieldData(File directory, String data) Creates the File 'fielddata.dat' in the specified directory
static File	createImageDataFile(File directory, Hashtable valuesImages) Creates the data files with image values.
static File	createTableDataDefinition(File directory, Hashtable valuesTable, DateFormat df) Creates table definition files Creates one file for each table and one index file (tableIndex.txt)
static File	createTableDataDefinition(File directory, Hashtable valuesTable, DateFormat df, NumberFormat numberFormat)
static File	createTableDataFile(File directory, Hashtable valuesTable) Creates the data files with table values.
static File	createTableDataFile(File directory, Hashtable valuesTable, String indexFileName)
static String	exportFieldData(Hashtable data, String delimiter, DateFormat df) Creates a String with format: key1 + delimiter + value1 + delimiter + key2 + delimiter + value2 + delimiter + ... + keyN + delimiter + valueN
static String	exportFieldData(Hashtable data, String delimiter, DateFormat df, NumberFormat numberFormat) Creates a String with format: key1 + delimiter + value1 + delimiter + key2 + delimiter + value2 + delimiter + ... + keyN + delimiter + valueN
static String	exportTableData(Hashtable data) Creates a String with all table data.
File	fillDocument(InputStream input, String nameFile, Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages) Fills the template
File	fillDocument(String resource, Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages) Fills the specified template
File	fillDocument(String resource, Hashtable fieldValues, Hashtable valuesTable, Hashtable valuesImages, Hashtable valuesPivotTable)
static Object[]	getKeysOrder(Hashtable data)
protected static double	getScreenPoints(int pixelsValue) Calculates the screen point for a pixel value
protected static String	parseNumber(Number number, NumberFormat numberFormat)
static void	savePngImageFile(Image im, File fImage) Save the image in the specified File as a png Image.
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
static String	transformFieldData(Hashtable dataField, DateFormat df) Creates a String with format: key1 + delimiter + value1 + delimiter + key2 + delimiter + value2 + delimiter + ... + keyN + delimiter + valueN Replace all "\n" for "\r" to delete the carriage return
static String	transformFieldData(Hashtable dataField, DateFormat df, NumberFormat numberFormat) Creates a String with format: key1 + delimiter + value1 + delimiter + key2 + delimiter + value2 + delimiter + ... + keyN + delimiter + valueN Replace all "\n" for "\r" to delete the carriage return

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ontimize.util.templates.TemplateGenerator

createTemplate, fillDocument, queryTemplateFields, queryTemplateFields, setShowTemplate

Field Detail

DEBUG

public static boolean DEBUG

createLabelsInTemplate

protected static boolean createLabelsInTemplate

Variable used to show labels in the template or not, if createLabelsInTemplate is false only the bookmarks are added to the template, without any label

dateFormat

protected DateFormat dateFormat

numberFormat

protected NumberFormat numberFormat

Constructor Detail

AbstractTemplateGenerator

public AbstractTemplateGenerator()

Method Detail

fillDocument

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

Description copied from interface: TemplateGenerator

Fills the specified template

Specified by:

fillDocument in interface TemplateGenerator

Parameters:

resource - : Resource where the template is located.

fieldValues - Values for the data fields

valuesTable - Table values

valuesImages - Image values

Returns:

Throws:

Exception

fillDocument

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

Description copied from interface: TemplateGenerator

Fills the template

Specified by:

fillDocument in interface TemplateGenerator

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

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

Specified by:

fillDocument in interface TemplateGenerator

Throws:

Exception

setCreateLabelsInTemplate

public void setCreateLabelsInTemplate(boolean createLabels)

Specified by:

setCreateLabelsInTemplate in interface TemplateGenerator

transformFieldData

public static String transformFieldData(Hashtable dataField,
                        DateFormat df)

Creates a String with format: key1 + delimiter + value1 + delimiter + key2 + delimiter + value2 + delimiter + ... + keyN + delimiter + valueN Replace all "\n" for "\r" to delete the carriage return

Parameters:

dataField -

df -

Returns:

See Also:

exportFieldData(Hashtable, String, DateFormat)

transformFieldData

public static String transformFieldData(Hashtable dataField,
                        DateFormat df,
                        NumberFormat numberFormat)

Creates a String with format: key1 + delimiter + value1 + delimiter + key2 + delimiter + value2 + delimiter + ... + keyN + delimiter + valueN Replace all "\n" for "\r" to delete the carriage return

Parameters:

dataField -

df -

numberFormat -

Returns:

See Also:

exportFieldData(Hashtable, String, DateFormat,NumberFormat)

createFileFieldData

public static File createFileFieldData(File directory,
                       String data)
                                throws Exception

Creates the File 'fielddata.dat' in the specified directory

Parameters:

directory - Directory

data - File content

Returns:

Throws:

Exception

createTableDataFile

public static File createTableDataFile(File directory,
                       Hashtable valuesTable)
                                throws Exception

Creates the data files with table values.
Creates one file for each table and one index file (tableIndex.txt)

Parameters:

directory - Directory where the files will be created in

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

Returns:

The index file with name tableIndex.txt

Throws:

Exception

createTableDataFile

public static File createTableDataFile(File directory,
                       Hashtable valuesTable,
                       String indexFileName)
                                throws Exception

Parameters:

directory - Directory where the files will be created in

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

indexFileName - Name of the returned file with the table index

Returns:

Throws:

Exception

createTableDataDefinition

public static File createTableDataDefinition(File directory,
                             Hashtable valuesTable,
                             DateFormat df)
                                      throws Exception

Creates table definition files
Creates one file for each table and one index file (tableIndex.txt)

Parameters:

directory - Directory where the files will be created in

valuesTable - The object contains the table data to create the template. Each key must be the table entity name and value must be an Hashtable with column names and labels

df -

Returns:

The table index File

Throws:

Exception

createTableDataDefinition

public static File createTableDataDefinition(File directory,
                             Hashtable valuesTable,
                             DateFormat df,
                             NumberFormat numberFormat)
                                      throws Exception

Throws:

Exception

createImageDataFile

public static File createImageDataFile(File directory,
                       Hashtable valuesImages)
                                throws Exception

Creates the data files with image values.
Creates one file for each image and one index file (imageIndex.txt)

Parameters:

directory - Directory where the files will be created in

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

getScreenPoints

protected static double getScreenPoints(int pixelsValue)

Calculates the screen point for a pixel value

Parameters:

pixelsValue - number of pixels

Returns:

exportFieldData

public static String exportFieldData(Hashtable data,
                     String delimiter,
                     DateFormat df)

Creates a String with format: key1 + delimiter + value1 + delimiter + key2 + delimiter + value2 + delimiter + ... + keyN + delimiter + valueN

Parameters:

data - Hashtable with all data

delimiter - Delimiter to separate the fields

df - Format to use in date data fields

Returns:

exportFieldData

public static String exportFieldData(Hashtable data,
                     String delimiter,
                     DateFormat df,
                     NumberFormat numberFormat)

Creates a String with format: key1 + delimiter + value1 + delimiter + key2 + delimiter + value2 + delimiter + ... + keyN + delimiter + valueN

Parameters:

data - Hashtable with all data

delimiter - Delimiter to separate the fields

df - Format to use in date data fields

numberFormat - Format to use in the numeric fields

Returns:

parseNumber

protected static String parseNumber(Number number,
                 NumberFormat numberFormat)

exportTableData

public static String exportTableData(Hashtable data)

Creates a String with all table data. The String format is:
\n colName1 $ colData1.1 # colData1.2 # ...# colData1.N $ colName2 $ colData2.1 # colData2.2 # ...# colData2.N

Parameters:

data - Table data

Returns:

calculateRecordCount

public static int calculateRecordCount(Hashtable data)

Calculates the number of data rows.

Parameters:

data -

Returns:

The size of the first Vector found in the Hashtable

savePngImageFile

public static void savePngImageFile(Image im,
                    File fImage)
                             throws IOException

Save the image in the specified File as a png Image.

Parameters:

im - Image to save

fImage - File

Throws:

IOException

setDateFormat

public void setDateFormat(DateFormat df)

Description copied from interface: TemplateGenerator

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

Specified by:

setDateFormat in interface TemplateGenerator

Parameters:

df - Format

setNumberFormat

public void setNumberFormat(NumberFormat nf)

Description copied from interface: TemplateGenerator

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

Specified by:

setNumberFormat in interface TemplateGenerator

containsHashtableValue

public static boolean containsHashtableValue(Hashtable data)

Returns true if some of the values in the input parameter is another hashtable

Parameters:

data -

Returns:

getKeysOrder

public static Object[] getKeysOrder(Hashtable data)