net.sourceforge.rtf.template.velocity

Class RTFVelocityTransformerImpl

java.lang.Object

net.sourceforge.rtf.template.AbstractRTFDocumentTransformer

net.sourceforge.rtf.template.velocity.RTFVelocityTransformerImpl

All Implemented Interfaces:

IRTFFieldNameTransform, IRTFDocumentTransformer

public class RTFVelocityTransformerImpl
extends AbstractRTFDocumentTransformer

RTF Velocity Transformer which transform RTF Document to RTF Document with Velocity Macro.

Version:

1.0.0

Author:

Angelo ZERR

Field Summary

Fields inherited from class net.sourceforge.rtf.template.AbstractRTFDocumentTransformer

bookmarkBkmEndMap, bookmarkBkmIfMap, bookmarkElseMap, bookmarkEndIfMap, bookmarkEndMap, bookmarkIfMap, bookmarkStartMap, groupByPerPageBreak, lastEndLoopRTFBookmark, pageBeforeEndBookmarkMap, rowMustNotGenerateForeachList, RTF_ELEMENT_ANNOTATION, RTF_ELEMENT_BOOKMARK, RTF_ELEMENT_DOCUMENT, RTF_ELEMENT_FIELD, RTF_ELEMENT_PAGE, RTF_ELEMENT_ROW, RTF_ELEMENT_STRINGBUFFER, RTF_ELEMENT_USERPROPERTY, rtfTransformMap, startBookmarksList, startBookmarksNotEnded

Constructor Summary

Constructors

Constructor and Description
RTFVelocityTransformerImpl()

Method Summary

Modifier and Type	Method and Description
protected String	getForeach(String fieldName, String fieldNameWithListInfo)
protected String	getMacroElse()
protected String	getMacroEndForEach() Return string for end for each
protected String	getMacroEndIf()
protected String	getMacroIf(String condition)
protected String	getMacroPageBreak(String itemNameList, String rtfPageBreakContent)
protected String	getMacroPageBreak(String itemNameList, String rtfPageBreakContent, int groupByPerPageBreak)
protected String	getObjectValueList(String fieldName, boolean withGetter)
protected String	getObjectValueList(String fieldName, String fieldNameWithListInfo, boolean withGetter) Return velocity name used into #foreach for the field name fieldname. eg : for fieldname developers.Name, this function return $item_developers (if withGetter = false) and $item_developers.Name (if withGetter = true) for fieldname developers.Roles.Name, this function return $item_developers_roles (if withGetter = false) and $item_developers_roles.Name (if withGetter = true)

Methods inherited from class net.sourceforge.rtf.template.AbstractRTFDocumentTransformer

formatSubFieldName, getContextFields, getGroupByPerPageBreak, getItemListName, getTransformedFieldName, getTransformerConfig, isBookmarkElse, isBookmarkEndIf, isBookmarkEndLoop, isBookmarkIf, isBookmarkStartLoop, isCircularReferences, setCircularReferences, setGroupByPerPageBreak, setTransformerConfig, transform, transform, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

RTFVelocityTransformerImpl

public RTFVelocityTransformerImpl()

Method Detail

getMacroEndForEach

protected String getMacroEndForEach()

Description copied from class: AbstractRTFDocumentTransformer

Return string for end for each

Specified by:

getMacroEndForEach in class AbstractRTFDocumentTransformer

Returns:

getObjectValueList

protected String getObjectValueList(String fieldName,
                                    String fieldNameWithListInfo,
                                    boolean withGetter)

Return velocity name used into #foreach for the field name fieldname. eg :

• for fieldname developers.Name, this function return $item_developers (if withGetter = false) and $item_developers.Name (if withGetter = true)
• for fieldname developers.Roles.Name, this function return $item_developers_roles (if withGetter = false) and $item_developers_roles.Name (if withGetter = true)

Specified by:

getObjectValueList in class AbstractRTFDocumentTransformer

Parameters:

fieldName - field name to translate into velocity name.

withGetter - true if getter must be returned and false otherwise.

Returns:

getObjectValueList

protected String getObjectValueList(String fieldName,
                                    boolean withGetter)

Specified by:

getObjectValueList in class AbstractRTFDocumentTransformer

getForeach

protected String getForeach(String fieldName,
                            String fieldNameWithListInfo)

Specified by:

getForeach in class AbstractRTFDocumentTransformer

getMacroPageBreak

protected String getMacroPageBreak(String itemNameList,
                                   String rtfPageBreakContent)

Specified by:

getMacroPageBreak in class AbstractRTFDocumentTransformer

getMacroPageBreak

protected String getMacroPageBreak(String itemNameList,
                                   String rtfPageBreakContent,
                                   int groupByPerPageBreak)

Specified by:

getMacroPageBreak in class AbstractRTFDocumentTransformer

getMacroIf

protected String getMacroIf(String condition)

Specified by:

getMacroIf in class AbstractRTFDocumentTransformer

getMacroEndIf

protected String getMacroEndIf()

Specified by:

getMacroEndIf in class AbstractRTFDocumentTransformer

getMacroElse

protected String getMacroElse()

Specified by:

getMacroElse in class AbstractRTFDocumentTransformer