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 Object
implements IRTFDocumentTransformer, IRTFFieldNameTransform

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	bookmarkBkmEndMap
protected Map	bookmarkBkmIfMap
protected Map	bookmarkElseMap
protected Map	bookmarkEndIfMap
protected Map	bookmarkEndMap
protected Map	bookmarkIfMap Map of IF/ELSE/ENDIF Bookmark
protected Map	bookmarkStartMap Map of START/END LOOP 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 Map	pageBeforeEndBookmarkMap
protected 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_ANNOTATION
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 Map	rtfTransformMap
protected Vector	startBookmarksList This list contains start LOOP Bookmark
protected Map	startBookmarksNotEnded

Constructor Summary

Constructors

Constructor and Description
AbstractRTFDocumentTransformer()

Method Summary

Modifier and Type	Method and Description
protected String	formatSubFieldName(String fieldName)
RTFContextFields	getContextFields(IContext context, boolean hasCircularReferences)
protected abstract String	getForeach(String fieldName, String fieldNameWithListInfo)
int	getGroupByPerPageBreak()
protected String	getItemListName(String fieldName, String fieldNameWithListInfo)
protected abstract String	getMacroElse()
protected abstract String	getMacroEndForEach() Return string for end for each
protected abstract String	getMacroEndIf()
protected abstract String	getMacroIf(String condition)
protected abstract String	getMacroPageBreak(String itemNameList, String rtfPageBreakContent)
protected abstract String	getMacroPageBreak(String itemNameList, String rtfPageBreakContent, int groupByPerPageBreak)
protected abstract String	getObjectValueList(String fieldName, boolean withGetter)
protected abstract String	getObjectValueList(String fieldName, String fieldNameWithListInfo, boolean withGetter)
String	getTransformedFieldName(boolean fieldIsList, String fieldName)
TransformerConfig	getTransformerConfig()
boolean	isBookmarkElse(String bookmarkName)
boolean	isBookmarkEndIf(String bookmarkName)
boolean	isBookmarkEndLoop(String bookmarkName)
boolean	isBookmarkIf(String bookmarkName)
boolean	isBookmarkStartLoop(String bookmarkName)
boolean	isCircularReferences()
void	setCircularReferences(boolean circularReferences)
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, Vector elementList, 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

RTF_ELEMENT_ANNOTATION

protected static final int RTF_ELEMENT_ANNOTATION

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 List rowMustNotGenerateForeachList

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

bookmarkStartMap

protected Map bookmarkStartMap

Map of START/END LOOP Bookmark

bookmarkEndMap

protected Map bookmarkEndMap

bookmarkBkmEndMap

protected Map bookmarkBkmEndMap

pageBeforeEndBookmarkMap

protected Map pageBeforeEndBookmarkMap

startBookmarksNotEnded

protected Map startBookmarksNotEnded

lastEndLoopRTFBookmark

protected RTFBookmark lastEndLoopRTFBookmark

startBookmarksList

protected Vector startBookmarksList

This list contains start LOOP Bookmark

bookmarkIfMap

protected Map bookmarkIfMap

Map of IF/ELSE/ENDIF Bookmark

bookmarkEndIfMap

protected Map bookmarkEndIfMap

bookmarkElseMap

protected Map bookmarkElseMap

bookmarkBkmIfMap

protected Map bookmarkBkmIfMap

rtfTransformMap

protected 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 IOException

Specified by:

transform in interface IRTFDocumentTransformer

Throws:

IOException

transform

public RTFDocument transform(RTFDocument document,
                             RTFContextFields contextFields)
                      throws IOException

Specified by:

transform in interface IRTFDocumentTransformer

Throws:

IOException

transform

protected void transform(RTFElement parentElement,
                         Vector elementList,
                         Map contextFieldsMap)
                  throws IOException

Throws:

IOException

isBookmarkStartLoop

public boolean isBookmarkStartLoop(String bookmarkName)

isBookmarkEndLoop

public boolean isBookmarkEndLoop(String bookmarkName)

isBookmarkIf

public boolean isBookmarkIf(String bookmarkName)

isBookmarkEndIf

public boolean isBookmarkEndIf(String bookmarkName)

isBookmarkElse

public boolean isBookmarkElse(String bookmarkName)

getContextFields

public RTFContextFields getContextFields(IContext context,
                                         boolean hasCircularReferences)

setGroupByPerPageBreak

public void setGroupByPerPageBreak(int groupByPerPageBreak)

Specified by:

setGroupByPerPageBreak in interface IRTFDocumentTransformer

getItemListName

protected String getItemListName(String fieldName,
                                 String fieldNameWithListInfo)

getMacroEndForEach

protected abstract String getMacroEndForEach()

Return string for end for each

Returns:

the result.

getForeach

protected abstract String getForeach(String fieldName,
                                     String fieldNameWithListInfo)

getObjectValueList

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

getObjectValueList

protected abstract String getObjectValueList(String fieldName,
                                             boolean withGetter)

formatSubFieldName

protected String formatSubFieldName(String fieldName)

getTransformedFieldName

public String getTransformedFieldName(boolean fieldIsList,
                                      String fieldName)

Specified by:

getTransformedFieldName in interface IRTFFieldNameTransform

getMacroPageBreak

protected abstract String getMacroPageBreak(String itemNameList,
                                            String rtfPageBreakContent)

getMacroPageBreak

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

getMacroIf

protected abstract String getMacroIf(String condition)

getMacroEndIf

protected abstract String getMacroEndIf()

getMacroElse

protected abstract String getMacroElse()

isCircularReferences

public boolean isCircularReferences()

Specified by:

isCircularReferences in interface IRTFDocumentTransformer

setCircularReferences

public void setCircularReferences(boolean circularReferences)

Specified by:

setCircularReferences in interface IRTFDocumentTransformer

getGroupByPerPageBreak

public int getGroupByPerPageBreak()

Specified by:

getGroupByPerPageBreak in interface IRTFDocumentTransformer