net.sourceforge.rtf.usecases

Class AbstractRTFUseCase

java.lang.Object

net.sourceforge.rtf.usecases.AbstractRTFUseCase

Direct Known Subclasses:

RTFAnnotationWithVelocity, RTFCodeWithVelocity, RTFConditionWithFreemarker, RTFConditionWithVelocity, RTFJakartaVelocityProjectWithFreemarker, RTFJakartaVelocityProjectWithFreemarker, RTFJakartaVelocityProjectWithVelocity, RTFJakartaVelocityProjectWithVelocity, RTFTemplatePageBeakWithGroupWithFreemarker, RTFTemplatePageBeakWithGroupWithVelocity, RTFTemplatePageBreakWithFreemarker, RTFTemplatePageBreakWithVelocity, RTFTemplateWithBookmarkImbricated, RTFTemplateWithFormTextWithVelocity, RTFTemplateWithImageWithFreemarker, RTFTemplateWithImageWithVelocity, RTFTemplateWithMapWithVelocity, RTFTemplateWithRTFTable

public abstract class AbstractRTFUseCase
extends Object

Version:

1.0.0

Author:

Angelo ZERR

Constructor Summary

Constructors

Constructor and Description
AbstractRTFUseCase(String outDirectory)

Method Summary

Modifier and Type	Method and Description
protected int	getGroupByPerPageBreak()
protected RTFTemplate	getRtfTemplate()
String	getRtfTemplateImpl()
String	getXMLFields() Return String XML Mergefields used in your context and Bookmarks (for start and end loop)
boolean	isCircularReferences()
protected abstract void	putContext(IContext context) This method must be implement by class wich manage your RTF model.
protected void	putDefaultFormat(RTFTemplate template)
protected void	putGlobalContext(IContext context)
void	run(String rtfSource) Run RTFTemplate for merging rtfSource with the context putted with the method putContext which be must implement.
void	saveTransformedDocument(boolean saveTransformedDocument) set true if RTF with (velocity, freemarker,... macro) file must be generated and false otherwise.
void	saveXmlFields(String filename, boolean force) Save XML fields available into file.
protected void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCircularReferences(boolean circularReferences) true if context has circular references and false otherwise
protected void	setGroupByPerPageBreak(int groupByPerPageBreak) This value allow to group by content when there is PageBreak in order to group by content.
void	setRtfTemplateImpl(String rtfTemplateImpl)
void	setTransformerConfigFile(File transformerConfigFile)
void	setTransformerConfigFile(String transformerConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRTFUseCase

public AbstractRTFUseCase(String outDirectory)

Method Detail

run

public final void run(String rtfSource)
               throws Exception

Run RTFTemplate for merging rtfSource with the context putted with the method putContext which be must implement. After execution of this method, files rtfSource + ".<rtfTemplateImpl>.rtf" (RTF template implementation (vmRTFtemplate,...) and rtfSource + ".out.rtf" (RTF final with values of the context) will be generate.

Parameters:

rtfSource - RTF source model.

Throws:

Exception - the exception.

getXMLFields

public String getXMLFields()

Return String XML Mergefields used in your context and Bookmarks (for start and end loop)

Returns:

the result.

putDefaultFormat

protected void putDefaultFormat(RTFTemplate template)

putGlobalContext

protected void putGlobalContext(IContext context)

saveXmlFields

public void saveXmlFields(String filename,
                          boolean force)
                   throws Exception

Save XML fields available into file. If force parameter is false, the file is updated with new context (by keeping just description) otherwise the file is crushed with new context.

Parameters:

filename - the filename.

force - the force.

Throws:

Exception - the exception.

putContext

protected abstract void putContext(IContext context)

This method must be implement by class wich manage your RTF model. Put the context of your model (eg : context("date", new Date()); )

Parameters:

context - IContext

setTransformerConfigFile

public void setTransformerConfigFile(String transformerConfig)

setTransformerConfigFile

public void setTransformerConfigFile(File transformerConfigFile)

saveTransformedDocument

public void saveTransformedDocument(boolean saveTransformedDocument)

set true if RTF with (velocity, freemarker,... macro) file must be generated and false otherwise.

Parameters:

saveTransformedDocument - the saveTransformedDocument.

getRtfTemplateImpl

public String getRtfTemplateImpl()

setRtfTemplateImpl

public void setRtfTemplateImpl(String rtfTemplateImpl)

getGroupByPerPageBreak

protected int getGroupByPerPageBreak()

setGroupByPerPageBreak

protected void setGroupByPerPageBreak(int groupByPerPageBreak)

This value allow to group by content when there is PageBreak in order to group by content.

Parameters:

groupByPerPageBreak - the groupByPerPageBreak.

getRtfTemplate

protected RTFTemplate getRtfTemplate()

setApplicationContext

protected void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

isCircularReferences

public boolean isCircularReferences()

setCircularReferences

public void setCircularReferences(boolean circularReferences)

true if context has circular references and false otherwise

Parameters:

circularReferences - the circularReferences.