net.sourceforge.rtf.context

Class AbstractRTFContextReader

java.lang.Object

net.sourceforge.rtf.context.AbstractRTFContextReader

Direct Known Subclasses:

RTFContextFieldsReader, RTFXmlFieldsReader

public abstract class AbstractRTFContextReader
extends Object

Read velocity context to detect if Object JAVA putted into velocity context is list or not. To use this abstract class, you must implement event startReading and endReading.

Version:

1.0.0

Author:

Angelo ZERR

Field Summary

Fields

Modifier and Type	Field and Description
static String	MATCH_PATH_DEFINITIONS

Constructor Summary

Constructors

Constructor and Description
AbstractRTFContextReader() Default constructor which exclude package where name start with "java."
AbstractRTFContextReader(List excludedPackages) Constructor to customize you package name to exclude.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addBookmark(String bookmarkName, String type)
protected abstract void	addMergeField(String mergeFieldName, boolean mergeFieldIsList, String mergeFieldNameWithListInfo, boolean isImage)
protected abstract void	endReading()
void	excludePackageName(String packageName)
void	readContext(IContext context, boolean circularReferences) Read velocity context, launch event startReading at first and when read is finished launch event endReading.
void	readContext(IContext context, TransformerConfig transformerConfig, boolean circularReferences)
protected abstract void	startReading()

Methods inherited from class java.lang.Object

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

Field Detail

MATCH_PATH_DEFINITIONS

public static final String MATCH_PATH_DEFINITIONS

See Also:

Constant Field Values

Constructor Detail

AbstractRTFContextReader

public AbstractRTFContextReader()

Default constructor which exclude package where name start with "java." This exlusion is used when getter of one JAVA object of velocity context is computed. For instance when JAVA object is a String, you don't want have getter of String object.

AbstractRTFContextReader

public AbstractRTFContextReader(List excludedPackages)

Constructor to customize you package name to exclude.

Parameters:

excludedPackages - the excludedPackages.

Method Detail

excludePackageName

public void excludePackageName(String packageName)

readContext

public void readContext(IContext context,
                        TransformerConfig transformerConfig,
                        boolean circularReferences)

readContext

public void readContext(IContext context,
                        boolean circularReferences)

Read velocity context, launch event startReading at first and when read is finished launch event endReading.

Parameters:

context - the context.

circularReferences - the circularReferences.

startReading

protected abstract void startReading()

endReading

protected abstract void endReading()

addBookmark

protected abstract void addBookmark(String bookmarkName,
                                    String type)

addMergeField

protected abstract void addMergeField(String mergeFieldName,
                                      boolean mergeFieldIsList,
                                      String mergeFieldNameWithListInfo,
                                      boolean isImage)