fr.opensagres.xdocreport.template.velocity

Class VelocityDocumentFormatter

java.lang.Object

fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter

fr.opensagres.xdocreport.template.velocity.VelocityDocumentFormatter

All Implemented Interfaces:

IDocumentFormatter

public class VelocityDocumentFormatter
extends AbstractDocumentFormatter

Velocity document formatter used to format fields list with Velocity syntax.

Nested Class Summary

Nested classes/interfaces inherited from class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter

AbstractDocumentFormatter.DirectiveToParse

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ITEM_TOKEN

Fields inherited from class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter

NO_ESCAPE

Constructor Summary

Constructors

Constructor and Description
VelocityDocumentFormatter()

Method Summary

Modifier and Type	Method and Description
boolean	containsInterpolation(java.lang.String content)
int	extractListDirectiveInfo(java.lang.String content, DirectivesStack directives, boolean dontRemoveListDirectiveInfo)
java.lang.String	extractModelTokenPrefix(java.lang.String fieldName)
java.lang.String	formatAsCallTextStyling(long variableIndex, java.lang.String fieldName, java.lang.String documentKind, java.lang.String syntaxKind, boolean syntaxWithDirective, java.lang.String elementId, java.lang.String entryName)
java.lang.String	formatAsFieldItemList(java.lang.String content, java.lang.String fieldName)
java.lang.String	formatAsFieldItemList(java.lang.String content, java.lang.String fieldName, boolean forceAsField)
java.lang.String	formatAsSimpleField(boolean noescape, boolean encloseInDirective, java.lang.String... fields)
java.lang.String	formatAsTextStylingField(long variableIndex, java.lang.String property)
java.lang.String	getDefineDirective(java.lang.String name, java.lang.String value)
java.lang.String	getElseDirective()
java.lang.String	getEndIfDirective(java.lang.String fieldName)
java.lang.String	getEndLoopDirective(java.lang.String itemNameList)
java.lang.String	getEndNoParse()
java.lang.String	getFunctionDirective(boolean noescape, boolean encloseInDirective, java.lang.String key, java.lang.String methodName, java.lang.String... parameters)
int	getIndexOfScript(java.lang.String fieldName)
protected java.lang.String	getItemToken()
java.lang.String	getLoopCountDirective(java.lang.String fieldName)
java.lang.String	getSetDirective(java.lang.String name, java.lang.String value, boolean valueIsField)
java.lang.String	getStartIfDirective(java.lang.String fieldName, boolean exists)
java.lang.String	getStartLoopDirective(java.lang.String itemNameList, java.lang.String listName)
java.lang.String	getStartNoParse()
boolean	hasDirective(java.lang.String characters)
protected boolean	isModelField(java.lang.String content, java.lang.String fieldName)
int	parseEndDirective(java.lang.String content, DirectivesStack directives, boolean dontRemoveListDirectiveInfo, int startOfEndListDirectiveIndex)
int	parseStartIf(java.lang.String content, DirectivesStack directives, int startOfStartIfDirectiveIndex)
int	parseStartLoop(java.lang.String content, DirectivesStack directives, int startOfStartListDirectiveIndex)

Methods inherited from class fr.opensagres.xdocreport.template.formatter.AbstractDocumentFormatter

extractItemNameList, extractListDirectiveInfo, formatAsSimpleField, getDirectiveToParse, getEndDocumentDirective, getFunctionDirective, getFunctionDirective, getMinIndex, getSetDirective, getStartDocumentDirective, getStartIfDirective, getStartLoopDirective, getVariableName, setEndDocumentDirective, setStartDocumentDirective

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_TOKEN

protected static final java.lang.String ITEM_TOKEN

See Also:

Constant Field Values

Constructor Detail

VelocityDocumentFormatter

public VelocityDocumentFormatter()

Method Detail

formatAsFieldItemList

public java.lang.String formatAsFieldItemList(java.lang.String content,
                                              java.lang.String fieldName,
                                              boolean forceAsField)

formatAsFieldItemList

public java.lang.String formatAsFieldItemList(java.lang.String content,
                                              java.lang.String fieldName)

getStartLoopDirective

public java.lang.String getStartLoopDirective(java.lang.String itemNameList,
                                              java.lang.String listName)

getEndLoopDirective

public java.lang.String getEndLoopDirective(java.lang.String itemNameList)

getElseDirective

public java.lang.String getElseDirective()

isModelField

protected boolean isModelField(java.lang.String content,
                               java.lang.String fieldName)

Specified by:

isModelField in class AbstractDocumentFormatter

getItemToken

protected java.lang.String getItemToken()

Specified by:

getItemToken in class AbstractDocumentFormatter

getFunctionDirective

public java.lang.String getFunctionDirective(boolean noescape,
                                             boolean encloseInDirective,
                                             java.lang.String key,
                                             java.lang.String methodName,
                                             java.lang.String... parameters)

formatAsSimpleField

public java.lang.String formatAsSimpleField(boolean noescape,
                                            boolean encloseInDirective,
                                            java.lang.String... fields)

getStartIfDirective

public java.lang.String getStartIfDirective(java.lang.String fieldName,
                                            boolean exists)

getEndIfDirective

public java.lang.String getEndIfDirective(java.lang.String fieldName)

getLoopCountDirective

public java.lang.String getLoopCountDirective(java.lang.String fieldName)

containsInterpolation

public boolean containsInterpolation(java.lang.String content)

extractListDirectiveInfo

public int extractListDirectiveInfo(java.lang.String content,
                                    DirectivesStack directives,
                                    boolean dontRemoveListDirectiveInfo)

parseEndDirective

public int parseEndDirective(java.lang.String content,
                             DirectivesStack directives,
                             boolean dontRemoveListDirectiveInfo,
                             int startOfEndListDirectiveIndex)

parseStartIf

public int parseStartIf(java.lang.String content,
                        DirectivesStack directives,
                        int startOfStartIfDirectiveIndex)

parseStartLoop

public int parseStartLoop(java.lang.String content,
                          DirectivesStack directives,
                          int startOfStartListDirectiveIndex)

extractModelTokenPrefix

public java.lang.String extractModelTokenPrefix(java.lang.String fieldName)

getIndexOfScript

public int getIndexOfScript(java.lang.String fieldName)

formatAsCallTextStyling

public java.lang.String formatAsCallTextStyling(long variableIndex,
                                                java.lang.String fieldName,
                                                java.lang.String documentKind,
                                                java.lang.String syntaxKind,
                                                boolean syntaxWithDirective,
                                                java.lang.String elementId,
                                                java.lang.String entryName)

formatAsTextStylingField

public java.lang.String formatAsTextStylingField(long variableIndex,
                                                 java.lang.String property)

hasDirective

public boolean hasDirective(java.lang.String characters)

getSetDirective

public java.lang.String getSetDirective(java.lang.String name,
                                        java.lang.String value,
                                        boolean valueIsField)

getStartNoParse

public java.lang.String getStartNoParse()

getEndNoParse

public java.lang.String getEndNoParse()

getDefineDirective

public java.lang.String getDefineDirective(java.lang.String name,
                                           java.lang.String value)