net.sourceforge.rtf.template
Class AbstractRTFDocumentTransformer

java.lang.Object
  net.sourceforge.rtf.template.AbstractRTFDocumentTransformer

All Implemented Interfaces:

IRTFFieldNameTransform, IRTFDocumentTransformer

Direct Known Subclasses:

RTFFreemarkerTransformerImpl, RTFVelocityTransformerImpl

public abstract class AbstractRTFDocumentTransformer
extends java.lang.Object
implements IRTFDocumentTransformer, IRTFFieldNameTransform

Field Summary

protected java.util.Map	bookmarkBkmEndMap
protected java.util.Map	bookmarkEndMap
protected java.util.Map	bookmarkStartMap Map of Bookmark
protected int	groupByPerPageBreak This value allow to group by content when ther eis PageBreak in order to group by content.
protected RTFBookmark	lastEndLoopRTFBookmark
protected java.util.Map	pageBeforeEndBookmarkMap
protected java.util.List	rowMustNotGenerateForeachList When Row is after START_LOOP, Row must not generate #foreach This list contains row which not generate #foreach
protected static int	RTF_ELEMENT_BOOKMARK
protected static int	RTF_ELEMENT_DOCUMENT
protected static int	RTF_ELEMENT_FIELD
protected static int	RTF_ELEMENT_PAGE
protected static int	RTF_ELEMENT_ROW
protected static int	RTF_ELEMENT_STRINGBUFFER
protected static int	RTF_ELEMENT_USERPROPERTY
protected java.util.Map	rtfTransformMap
protected java.util.Vector	startBookmarksList This list contains start Bookmark
protected java.util.Map	startBookmarksNotEnded

Constructor Summary

AbstractRTFDocumentTransformer()

Method Summary

protected java.lang.String	formatSubFieldName(java.lang.String fieldName)
RTFContextFields	getContextFields(IContext context)
protected abstract java.lang.String	getForeach(java.lang.String fieldName, java.lang.String fieldNameWithListInfo)
protected java.lang.String	getItemListName(java.lang.String fieldName, java.lang.String fieldNameWithListInfo)
protected abstract java.lang.String	getMacroEndForEach() Return string for end for each
protected abstract java.lang.String	getMacroPageBreak(java.lang.String itemNameList, java.lang.String rtfPageBreakContent)
protected abstract java.lang.String	getMacroPageBreak(java.lang.String itemNameList, java.lang.String rtfPageBreakContent, int groupByPerPageBreak)
protected abstract java.lang.String	getObjectValueList(java.lang.String fieldName, boolean withGetter)
protected abstract java.lang.String	getObjectValueList(java.lang.String fieldName, java.lang.String fieldNameWithListInfo, boolean withGetter)
java.lang.String	getTransformedFieldName(boolean fieldIsList, java.lang.String fieldName)
TransformerConfig	getTransformerConfig()
boolean	isBookmarkEndLoop(java.lang.String bookmarkName)
boolean	isBookmarkStartLoop(java.lang.String bookmarkName)
void	setGroupByPerPageBreak(int groupByPerPageBreak)
void	setTransformerConfig(TransformerConfig transformerConfig)
RTFDocument	transform(RTFDocument document, IContext context)
RTFDocument	transform(RTFDocument document, RTFContextFields contextFields)
protected void	transform(RTFElement parentElement, java.util.Vector elementList, java.util.Map contextFieldsMap)

Methods inherited from class java.lang.Object

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

Field Detail

RTF_ELEMENT_DOCUMENT

protected static final int RTF_ELEMENT_DOCUMENT

See Also:

Constant Field Values

RTF_ELEMENT_STRINGBUFFER

protected static final int RTF_ELEMENT_STRINGBUFFER

See Also:

Constant Field Values

RTF_ELEMENT_ROW

protected static final int RTF_ELEMENT_ROW

See Also:

Constant Field Values

RTF_ELEMENT_FIELD

protected static final int RTF_ELEMENT_FIELD

See Also:

Constant Field Values

RTF_ELEMENT_BOOKMARK

protected static final int RTF_ELEMENT_BOOKMARK

See Also:

Constant Field Values

RTF_ELEMENT_PAGE

protected static final int RTF_ELEMENT_PAGE

See Also:

Constant Field Values

RTF_ELEMENT_USERPROPERTY

protected static final int RTF_ELEMENT_USERPROPERTY

See Also:

Constant Field Values

groupByPerPageBreak

protected int groupByPerPageBreak

This value allow to group by content when ther eis PageBreak in order to group by content.

rowMustNotGenerateForeachList

protected java.util.List rowMustNotGenerateForeachList

When Row is after START_LOOP, Row must not generate #foreach This list contains row which not generate #foreach

bookmarkStartMap

protected java.util.Map bookmarkStartMap

Map of Bookmark

bookmarkEndMap

protected java.util.Map bookmarkEndMap

bookmarkBkmEndMap

protected java.util.Map bookmarkBkmEndMap

pageBeforeEndBookmarkMap

protected java.util.Map pageBeforeEndBookmarkMap

startBookmarksNotEnded

protected java.util.Map startBookmarksNotEnded

lastEndLoopRTFBookmark

protected RTFBookmark lastEndLoopRTFBookmark

startBookmarksList

protected java.util.Vector startBookmarksList

This list contains start Bookmark

rtfTransformMap

protected java.util.Map rtfTransformMap

Constructor Detail

AbstractRTFDocumentTransformer

public AbstractRTFDocumentTransformer()

Method Detail

getTransformerConfig

public TransformerConfig getTransformerConfig()

setTransformerConfig

public void setTransformerConfig(TransformerConfig transformerConfig)

Specified by:

setTransformerConfig in interface IRTFDocumentTransformer

transform

public RTFDocument transform(RTFDocument document,
                             IContext context)
                      throws java.io.IOException

Specified by:

transform in interface IRTFDocumentTransformer

Throws:

java.io.IOException

transform

public RTFDocument transform(RTFDocument document,
                             RTFContextFields contextFields)
                      throws java.io.IOException

Specified by:

transform in interface IRTFDocumentTransformer

Throws:

java.io.IOException

transform

protected void transform(RTFElement parentElement,
                         java.util.Vector elementList,
                         java.util.Map contextFieldsMap)
                  throws java.io.IOException

Throws:

java.io.IOException

isBookmarkStartLoop

public boolean isBookmarkStartLoop(java.lang.String bookmarkName)

isBookmarkEndLoop

public boolean isBookmarkEndLoop(java.lang.String bookmarkName)

getContextFields

public RTFContextFields getContextFields(IContext context)

setGroupByPerPageBreak

public void setGroupByPerPageBreak(int groupByPerPageBreak)

Specified by:

setGroupByPerPageBreak in interface IRTFDocumentTransformer

getItemListName

protected java.lang.String getItemListName(java.lang.String fieldName,
                                           java.lang.String fieldNameWithListInfo)

getMacroEndForEach

protected abstract java.lang.String getMacroEndForEach()

Return string for end for each

Returns:

getForeach

protected abstract java.lang.String getForeach(java.lang.String fieldName,
                                               java.lang.String fieldNameWithListInfo)

getObjectValueList

protected abstract java.lang.String getObjectValueList(java.lang.String fieldName,
                                                       java.lang.String fieldNameWithListInfo,
                                                       boolean withGetter)

getObjectValueList

protected abstract java.lang.String getObjectValueList(java.lang.String fieldName,
                                                       boolean withGetter)

formatSubFieldName

protected java.lang.String formatSubFieldName(java.lang.String fieldName)

getTransformedFieldName

public java.lang.String getTransformedFieldName(boolean fieldIsList,
                                                java.lang.String fieldName)

Specified by:

getTransformedFieldName in interface IRTFFieldNameTransform

getMacroPageBreak

protected abstract java.lang.String getMacroPageBreak(java.lang.String itemNameList,
                                                      java.lang.String rtfPageBreakContent)

getMacroPageBreak

protected abstract java.lang.String getMacroPageBreak(java.lang.String itemNameList,
                                                      java.lang.String rtfPageBreakContent,
                                                      int groupByPerPageBreak)