com.jamasoftware.contour.report.util

Class VelocityReportUtil

java.lang.Object

com.jamasoftware.contour.report.util.VelocityReportUtil

public class VelocityReportUtil
extends Object

Utility methods for velocity report.

Constructor Summary

Constructors

Constructor and Description
VelocityReportUtil(com.jamasoftware.contour.util.type.FieldDataTypeManager fieldDataTypeManager)

Method Summary

Methods

Modifier and Type	Method and Description
String	cleanText(String html) This method will go through the provided text cleaning out unnecessary syntax.
static Map<String,Object>	convertStringParamsToReportParams(Map<String,String> map, HttpSession session)
String	encodeTextForHTML(String str) This method will search through the provided text looking for html/xml tags and replacing them with the ascii equivalent.
String	fromHtmlToRawText(String orig)
String	getValueForField(ContourItem doc, com.jamasoftware.contour.api.service.dto.DocumentTypeDTO documentType, String fieldName, com.jamasoftware.contour.api.util.DateFormatter dateFormat) Gets string value for the given field.
String	getValueForField(ContourItem doc, com.jamasoftware.contour.api.service.dto.DocumentTypeDTO documentType, String fieldName, com.jamasoftware.contour.api.util.DateFormatter dateFormat, boolean exportToExcel) Gets string value for the given field.
String	getValueForField(ContourItem doc, com.jamasoftware.contour.api.service.dto.DocumentTypeFieldDTO fieldDTO, com.jamasoftware.contour.api.util.DateFormatter dateFormat) Gets string value for the given field.
String	getValueForField(ContourItem doc, com.jamasoftware.contour.api.service.dto.DocumentTypeFieldDTO fieldDTO, com.jamasoftware.contour.api.util.DateFormatter dateFormat, boolean exportToExcel) Gets string value for the given field.
String	getValueForField(ContourItem doc, String fieldName, com.jamasoftware.contour.api.util.DateFormatter dateFormat)
String	replaceBreakForExcel(String str) This will search through the provided text looking for HTML breaks and Word style breaks and replace them with a simple line break so that the output to Excel.
String	replaceMSCharacters(String orig, boolean keepNewLines) This will replace all Microsoft special characters.

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityReportUtil

public VelocityReportUtil(com.jamasoftware.contour.util.type.FieldDataTypeManager fieldDataTypeManager)

Method Detail

getValueForField

public String getValueForField(ContourItem doc,
                      com.jamasoftware.contour.api.service.dto.DocumentTypeDTO documentType,
                      String fieldName,
                      com.jamasoftware.contour.api.util.DateFormatter dateFormat)

Gets string value for the given field.

Parameters:

doc - document

documentType - document type for the document

fieldName - name of the field (not the label)

dateFormat - date formatter

Returns:

string value

getValueForField

public String getValueForField(ContourItem doc,
                      com.jamasoftware.contour.api.service.dto.DocumentTypeDTO documentType,
                      String fieldName,
                      com.jamasoftware.contour.api.util.DateFormatter dateFormat,
                      boolean exportToExcel)

Gets string value for the given field.

Parameters:

doc - document

documentType - document type for the document

fieldName - name of the field (not the label)

dateFormat - date formatter

exportToExcel - whether to export to Excel or not. If export to Excel, the HTML tags will be escaped.

Returns:

string value

getValueForField

public String getValueForField(ContourItem doc,
                      com.jamasoftware.contour.api.service.dto.DocumentTypeFieldDTO fieldDTO,
                      com.jamasoftware.contour.api.util.DateFormatter dateFormat)

Gets string value for the given field.

Parameters:

doc - document

fieldDTO - field definition

dateFormat - date formatter

Returns:

string value

getValueForField

public String getValueForField(ContourItem doc,
                      com.jamasoftware.contour.api.service.dto.DocumentTypeFieldDTO fieldDTO,
                      com.jamasoftware.contour.api.util.DateFormatter dateFormat,
                      boolean exportToExcel)

Gets string value for the given field.

Parameters:

doc - document

fieldDTO - field definition

dateFormat - date formatter

exportToExcel - whether to export to Excel or not. If export to Excel, the HTML tags will be escaped.

Returns:

string value

getValueForField

public String getValueForField(ContourItem doc,
                      String fieldName,
                      com.jamasoftware.contour.api.util.DateFormatter dateFormat)

replaceBreakForExcel

public String replaceBreakForExcel(String str)

This will search through the provided text looking for HTML breaks and Word style breaks and replace them with a simple line break so that the output to Excel.
For example if you would like to display a rich text field in Excel the HTML breaks are treated as new cells. This method will convert the breaks so the text displays correctly in a single Excell cell.

Parameters:

str -

Returns:

str with HTML breaks replaced with line breaks

encodeTextForHTML

public String encodeTextForHTML(String str)

This method will search through the provided text looking for html/xml tags and replacing them with the ascii equivalent. Line breaks will also be converted to true HTML breaks.
For example if you use a regular text box on the form within Contour the line breaks will be ignored when displayed in Word. Using the method will ensure those breaks show up. This method will also ensure that if you have entered explicit xml/html tags they will be converted to show up as they were entered.

Parameters:

str -

Returns:

str encoded for HTML

cleanText

public String cleanText(String html)

This method will go through the provided text cleaning out unnecessary syntax.
For example this is a useful if the text has been copied from Word which will result in a lot of extra data which can cause odd behavior in reports.

Parameters:

html -

Returns:

html cleaned of unnecessary syntax

fromHtmlToRawText

public String fromHtmlToRawText(String orig)

replaceMSCharacters

public String replaceMSCharacters(String orig,
                         boolean keepNewLines)

This will replace all Microsoft special characters.
For example if text has been copied by Word chances are things like quotes, dash etc are all special characters.

Parameters:

orig -

keepNewLines -

Returns:

orig string with Microsoft special characters replaced

convertStringParamsToReportParams

public static Map<String,Object> convertStringParamsToReportParams(Map<String,String> map,
                                                   HttpSession session)