Package eu.europa.ted.efx.sdk1

Class EfxTemplateTranslatorV1

java.lang.Object

eu.europa.ted.efx.sdk1.EfxBaseListener

eu.europa.ted.efx.sdk1.EfxExpressionTranslatorV1

eu.europa.ted.efx.sdk1.EfxTemplateTranslatorV1

All Implemented Interfaces:

EfxExpressionTranslator, EfxTemplateTranslator, EfxListener, org.antlr.v4.runtime.tree.ParseTreeListener

public class EfxTemplateTranslatorV1
extends EfxExpressionTranslatorV1
implements EfxTemplateTranslator

The EfxTemplateTranslator extends the EfxExpressionTranslatorV1 to provide additional translation capabilities for EFX templates. If has been implemented as an extension to the EfxExpressionTranslator in order to keep things simpler when one only needs to translate EFX expressions (like the condition associated with a business rule).

Field Summary

Fields inherited from class eu.europa.ted.efx.sdk1.EfxExpressionTranslatorV1

efxContext, errorListener, script, stack, symbols

Constructor Summary

Constructors

Constructor	Description
EfxTemplateTranslatorV1(MarkupGenerator markupGenerator, SymbolResolver symbolResolver, ScriptGenerator scriptGenerator, org.antlr.v4.runtime.BaseErrorListener errorListener)

Method Summary

Modifier and Type	Method	Description
void	enterTemplateFile(EfxParser.TemplateFileContext ctx)	Template File
void	exitAssetId(EfxParser.AssetIdContext ctx)	Exit a parse tree produced by EfxParser.assetId().
void	exitAssetType(EfxParser.AssetTypeContext ctx)	Exit a parse tree produced by EfxParser.assetType().
void	exitContextDeclarationBlock(EfxParser.ContextDeclarationBlockContext ctx)	This method changes the current EFX context.
void	exitExpressionTemplate(EfxParser.ExpressionTemplateContext ctx)	Exit a parse tree produced by the expressionTemplate labeled alternative in EfxParser.templateFragment().
void	exitLabelTemplate(EfxParser.LabelTemplateContext ctx)	Exit a parse tree produced by the labelTemplate labeled alternative in EfxParser.templateFragment().
void	exitLabelType(EfxParser.LabelTypeContext ctx)	Exit a parse tree produced by EfxParser.labelType().
void	exitShorthandBtLabelReference(EfxParser.ShorthandBtLabelReferenceContext ctx)	Exit a parse tree produced by the shorthandBtLabelReference labeled alternative in EfxParser.labelBlock().
void	exitShorthandFieldLabelReference(EfxParser.ShorthandFieldLabelReferenceContext ctx)	Exit a parse tree produced by the shorthandFieldLabelReference labeled alternative in EfxParser.labelBlock().
void	exitShorthandFieldValueReferenceFromContextField(EfxParser.ShorthandFieldValueReferenceFromContextFieldContext ctx)	Handles the $value shorthand syntax which renders the value of the field declared as context in the current line of the template.
void	exitShorthandIndirectLabelReference(EfxParser.ShorthandIndirectLabelReferenceContext ctx)	Exit a parse tree produced by the shorthandIndirectLabelReference labeled alternative in EfxParser.labelBlock().
void	exitShorthandIndirectLabelReferenceFromContextField(EfxParser.ShorthandIndirectLabelReferenceFromContextFieldContext ctx)	Handles the #value shorthand syntax which renders the label corresponding to the value of the the field declared as the context of the current line of the template.
void	exitShorthandLabelReferenceFromContext(EfxParser.ShorthandLabelReferenceFromContextContext ctx)	Handles the #{labelType} shorthand syntax which renders the label of the Field or Node declared as the context.
void	exitStandardExpressionBlock(EfxParser.StandardExpressionBlockContext ctx)	Handles a standard expression block in a template line.
void	exitStandardLabelReference(EfxParser.StandardLabelReferenceContext ctx)	Label Blocks #{...}
void	exitTemplateFile(EfxParser.TemplateFileContext ctx)	Exit a parse tree produced by EfxParser.templateFile().
void	exitTemplateLine(EfxParser.TemplateLineContext ctx)	Template lines
void	exitTextTemplate(EfxParser.TextTemplateContext ctx)	Source template blocks
String	renderTemplate(InputStream stream)
String	renderTemplate(String template)	Translates the template contained in the string passed as a parameter.
String	renderTemplate(Path pathname)	Opens the indicated EFX file and translates the EFX template it contains.

Methods inherited from class eu.europa.ted.efx.sdk1.EfxExpressionTranslatorV1

enterAbsoluteFieldReference, enterAbsoluteNodeReference, enterFieldReferenceInOtherNotice, enterPredicate, enterSingleExpression, exitAbsoluteFieldReference, exitAbsoluteNodeReference, exitAdditionExpression, exitBooleanComparison, exitBooleanInListCondition, exitBooleanIteratorExpression, exitBooleanList, exitBooleanParameterDeclaration, exitBooleanSequenceFromIteration, exitBooleanVariableDeclaration, exitCodeList, exitCodelistReference, exitConcatFunction, exitConditionalBooleanExpression, exitConditionalDateExpression, exitConditionalDurationExpression, exitConditionalNumericExpression, exitConditionalStringExpression, exitConditionalTimeExpression, exitContainsFunction, exitContextFieldSpecifier, exitContextIteratorExpression, exitContextNodeSpecifier, exitContextVariableDeclaration, exitContextVariableSpecifier, exitCountFunction, exitDateComparison, exitDateFromStringFunction, exitDateInListCondition, exitDateIteratorExpression, exitDateList, exitDateLiteral, exitDateMinusMeasureFunction, exitDateParameterDeclaration, exitDatePlusMeasureFunction, exitDateSequenceFromIteration, exitDateSubtractionExpression, exitDateVariableDeclaration, exitDayTimeDurationFromStringFunction, exitDistinctValuesFunction, exitDurationAdditionExpression, exitDurationComparison, exitDurationInListCondition, exitDurationIteratorExpression, exitDurationLeftMultiplicationExpression, exitDurationList, exitDurationLiteral, exitDurationParameterDeclaration, exitDurationRightMultiplicationExpression, exitDurationSequenceFromIteration, exitDurationSubtractionExpression, exitDurationVariableDeclaration, exitEmptinessCondition, exitEndsWithFunction, exitExceptFunction, exitFalseBooleanLiteral, exitFieldReferenceInOtherNotice, exitFieldReferenceWithAxis, exitFieldReferenceWithFieldContextOverride, exitFieldReferenceWithNodeContextOverride, exitFieldReferenceWithPredicate, exitFieldReferenceWithVariableContextOverride, exitFieldValueComparison, exitFormatNumberFunction, exitIntersectFunction, exitIterationExpression, exitIteratorExpression, exitIteratorList, exitLikePatternCondition, exitLogicalAndCondition, exitLogicalOrCondition, exitMultiplicationExpression, exitNodeReferenceWithPredicate, exitNotFunction, exitNoticeReference, exitNumberFunction, exitNumberInListCondition, exitNumericComparison, exitNumericIteratorExpression, exitNumericList, exitNumericLiteral, exitNumericParameterDeclaration, exitNumericSequenceFromIteration, exitNumericVariableDeclaration, exitParenthesizedBooleanExpression, exitParenthesizedBooleansFromIteration, exitParenthesizedDatesFromIteration, exitParenthesizedDurationsFromITeration, exitParenthesizedNumbersFromIteration, exitParenthesizedNumericExpression, exitParenthesizedStringsFromIteration, exitParenthesizedTimesFromIteration, exitPredicate, exitPresenceCondition, exitQuantifiedExpression, exitScalarFromAttributeReference, exitScalarFromFieldReference, exitSequenceEqualFunction, exitSequenceFromFieldReference, exitSimpleFieldReference, exitSimpleNodeReference, exitSingleExpression, exitStartsWithFunction, exitStringComparison, exitStringInListCondition, exitStringIteratorExpression, exitStringLengthFunction, exitStringList, exitStringLiteral, exitStringParameterDeclaration, exitStringSequenceFromIteration, exitStringVariableDeclaration, exitSubstringFunction, exitSumFunction, exitTimeComparison, exitTimeFromStringFunction, exitTimeInListCondition, exitTimeIteratorExpression, exitTimeList, exitTimeLiteral, exitTimeParameterDeclaration, exitTimeSequenceFromIteration, exitTimeVariableDeclaration, exitToStringFunction, exitTrueBooleanLiteral, exitUnionFunction, exitUniqueValueCondition, exitUntypedConditionalExpression, exitVariableReference, exitYearMonthDurationFromStringFunction, getFieldIdFromChildSimpleFieldReferenceContext, getNodeIdFromChildSimpleNodeReferenceContext, translateExpression

Methods inherited from class eu.europa.ted.efx.sdk1.EfxBaseListener

enterAdditionExpression, enterAssetId, enterAssetType, enterAttributeReference, enterAxis, enterBooleanCastExpression, enterBooleanComparison, enterBooleanFunctionExpression, enterBooleanInListCondition, enterBooleanIteratorExpression, enterBooleanList, enterBooleanLiteral, enterBooleanLiteralExpression, enterBooleanParameterDeclaration, enterBooleanSequenceFromIteration, enterBooleansFromIteration, enterBooleanTypeCastFieldReference, enterBooleanVariableDeclaration, enterCodeList, enterCodelistId, enterCodelistReference, enterConcatFunction, enterConditionalBooleanExpression, enterConditionalDateExpression, enterConditionalDurationExpression, enterConditionalNumericExpression, enterConditionalStringExpression, enterConditionalTimeExpression, enterContainsFunction, enterContextDeclarationBlock, enterContextFieldSpecifier, enterContextIteratorExpression, enterContextNodeSpecifier, enterContextVariableDeclaration, enterContextVariableSpecifier, enterCountFunction, enterDateCastExpression, enterDateComparison, enterDateFromStringFunction, enterDateFunctionExpression, enterDateInListCondition, enterDateIteratorExpression, enterDateList, enterDateLiteral, enterDateLiteralExpression, enterDateMinusMeasureFunction, enterDateParameterDeclaration, enterDatePlusMeasureFunction, enterDateSequenceFromIteration, enterDatesFromIteration, enterDateSubtractionExpression, enterDateTypeCastFieldReference, enterDateVariableDeclaration, enterDayTimeDurationFromStringFunction, enterDistinctValuesFunction, enterDurationAdditionExpression, enterDurationCastExpression, enterDurationComparison, enterDurationFunctionExpression, enterDurationInListCondition, enterDurationIteratorExpression, enterDurationLeftMultiplicationExpression, enterDurationList, enterDurationLiteral, enterDurationLiteralExpression, enterDurationParameterDeclaration, enterDurationRightMultiplicationExpression, enterDurationSequenceFromIteration, enterDurationsFromIteration, enterDurationSubtractionExpression, enterDurationTypeCastFieldReference, enterDurationVariableDeclaration, enterEmptinessCondition, enterEndsWithFunction, enterEveryRule, enterExceptFunction, enterExpression, enterExpressionTemplate, enterFalseBooleanLiteral, enterFieldContext, enterFieldReference, enterFieldReferenceWithAxis, enterFieldReferenceWithFieldContextOverride, enterFieldReferenceWithNodeContextOverride, enterFieldReferenceWithPredicate, enterFieldReferenceWithVariableContextOverride, enterFieldValueComparison, enterFormatNumberFunction, enterIntersectFunction, enterIteratorExpression, enterIteratorList, enterLabelTemplate, enterLabelType, enterLikePatternCondition, enterLogicalAndCondition, enterLogicalOrCondition, enterMultiplicationExpression, enterNodeContext, enterNodeReference, enterNodeReferenceInOtherNotice, enterNodeReferenceWithPredicate, enterNotFunction, enterNoticeReference, enterNumberFunction, enterNumberInListCondition, enterNumbersFromIteration, enterNumericCastExpression, enterNumericComparison, enterNumericFunctionExpression, enterNumericIteratorExpression, enterNumericList, enterNumericLiteral, enterNumericLiteralExpression, enterNumericParameterDeclaration, enterNumericSequenceFromIteration, enterNumericTypeCastFieldReference, enterNumericVariableDeclaration, enterOtherAssetId, enterParameterList, enterParameterValue, enterParenthesizedBooleanExpression, enterParenthesizedBooleansFromIteration, enterParenthesizedDatesFromIteration, enterParenthesizedDurationExpression, enterParenthesizedDurationsFromITeration, enterParenthesizedNumbersFromIteration, enterParenthesizedNumericExpression, enterParenthesizedStringsFromIteration, enterParenthesizedTimesFromIteration, enterPathFromReference, enterPresenceCondition, enterQuantifiedExpression, enterScalarFromAttributeReference, enterScalarFromFieldReference, enterSequenceEqualFunction, enterSequenceExpression, enterSequenceFromAttributeReference, enterSequenceFromFieldReference, enterShorthandBtLabelReference, enterShorthandFieldLabelReference, enterShorthandFieldValueReferenceFromContextField, enterShorthandIndirectLabelReference, enterShorthandIndirectLabelReferenceFromContextField, enterShorthandLabelReferenceFromContext, enterSimpleFieldReference, enterSimpleNodeReference, enterStandardExpressionBlock, enterStandardLabelReference, enterStartsWithFunction, enterStringCastExpression, enterStringComparison, enterStringFunctionExpression, enterStringInListCondition, enterStringIteratorExpression, enterStringLengthFunction, enterStringList, enterStringLiteral, enterStringLiteralExpression, enterStringParameterDeclaration, enterStringSequenceFromIteration, enterStringsFromIteration, enterStringTypeCastFieldReference, enterStringVariableDeclaration, enterSubstringFunction, enterSumFunction, enterTemplate, enterTemplateLine, enterTextBlock, enterTextTemplate, enterTimeCastExpression, enterTimeComparison, enterTimeFromStringFunction, enterTimeFunctionExpression, enterTimeInListCondition, enterTimeIteratorExpression, enterTimeList, enterTimeLiteral, enterTimeLiteralExpression, enterTimeParameterDeclaration, enterTimeSequenceFromIteration, enterTimesFromIteration, enterTimeTypeCastFieldReference, enterTimeVariableDeclaration, enterToStringFunction, enterTrueBooleanLiteral, enterUnionFunction, enterUniqueValueCondition, enterUntypedBooleanExpression, enterUntypedConditionalExpression, enterUntypedDateExpression, enterUntypedDurationExpression, enterUntypedFieldReferenceExpression, enterUntypedNumericExpression, enterUntypedSequenceExpression, enterUntypedStringExpression, enterUntypedTimeExpression, enterUntypedVariableExpression, enterVariableReference, enterWhitespace, enterYearMonthDurationFromStringFunction, exitAttributeReference, exitAxis, exitBooleanCastExpression, exitBooleanFunctionExpression, exitBooleanLiteral, exitBooleanLiteralExpression, exitBooleansFromIteration, exitBooleanTypeCastFieldReference, exitCodelistId, exitDateCastExpression, exitDateFunctionExpression, exitDateLiteralExpression, exitDatesFromIteration, exitDateTypeCastFieldReference, exitDurationCastExpression, exitDurationFunctionExpression, exitDurationLiteralExpression, exitDurationsFromIteration, exitDurationTypeCastFieldReference, exitEveryRule, exitExpression, exitFieldContext, exitFieldReference, exitIteratorExpression, exitNodeContext, exitNodeReference, exitNodeReferenceInOtherNotice, exitNumbersFromIteration, exitNumericCastExpression, exitNumericFunctionExpression, exitNumericLiteralExpression, exitNumericTypeCastFieldReference, exitOtherAssetId, exitParameterList, exitParameterValue, exitParenthesizedDurationExpression, exitPathFromReference, exitSequenceExpression, exitSequenceFromAttributeReference, exitStringCastExpression, exitStringFunctionExpression, exitStringLiteralExpression, exitStringsFromIteration, exitStringTypeCastFieldReference, exitTemplate, exitTextBlock, exitTimeCastExpression, exitTimeFunctionExpression, exitTimeLiteralExpression, exitTimesFromIteration, exitTimeTypeCastFieldReference, exitUntypedBooleanExpression, exitUntypedDateExpression, exitUntypedDurationExpression, exitUntypedFieldReferenceExpression, exitUntypedNumericExpression, exitUntypedSequenceExpression, exitUntypedStringExpression, exitUntypedTimeExpression, exitUntypedVariableExpression, exitWhitespace, visitErrorNode, visitTerminal

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.europa.ted.efx.interfaces.EfxExpressionTranslator

translateExpression

Constructor Detail

EfxTemplateTranslatorV1

public EfxTemplateTranslatorV1(MarkupGenerator markupGenerator,
                               SymbolResolver symbolResolver,
                               ScriptGenerator scriptGenerator,
                               org.antlr.v4.runtime.BaseErrorListener errorListener)

Method Detail

renderTemplate

public String renderTemplate(Path pathname)
                      throws IOException

Opens the indicated EFX file and translates the EFX template it contains.

Specified by:

renderTemplate in interface EfxTemplateTranslator

Throws:

IOException

renderTemplate

public String renderTemplate(String template)

Translates the template contained in the string passed as a parameter.

Specified by:

renderTemplate in interface EfxTemplateTranslator

renderTemplate

public String renderTemplate(InputStream stream)
                      throws IOException

Specified by:

renderTemplate in interface EfxTemplateTranslator

Throws:

IOException

enterTemplateFile

public void enterTemplateFile(EfxParser.TemplateFileContext ctx)

Template File

Specified by:

enterTemplateFile in interface EfxListener

Overrides:

enterTemplateFile in class EfxBaseListener

Parameters:

ctx - the parse tree

exitTemplateFile

public void exitTemplateFile(EfxParser.TemplateFileContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by EfxParser.templateFile().

The default implementation does nothing.

Specified by:

exitTemplateFile in interface EfxListener

Overrides:

exitTemplateFile in class EfxBaseListener

Parameters:

ctx - the parse tree

exitTextTemplate

public void exitTextTemplate(EfxParser.TextTemplateContext ctx)

Source template blocks

Specified by:

exitTextTemplate in interface EfxListener

Overrides:

exitTextTemplate in class EfxBaseListener

Parameters:

ctx - the parse tree

exitLabelTemplate

public void exitLabelTemplate(EfxParser.LabelTemplateContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by the labelTemplate labeled alternative in EfxParser.templateFragment().

The default implementation does nothing.

Specified by:

exitLabelTemplate in interface EfxListener

Overrides:

exitLabelTemplate in class EfxBaseListener

Parameters:

ctx - the parse tree

exitExpressionTemplate

public void exitExpressionTemplate(EfxParser.ExpressionTemplateContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by the expressionTemplate labeled alternative in EfxParser.templateFragment().

The default implementation does nothing.

Specified by:

exitExpressionTemplate in interface EfxListener

Overrides:

exitExpressionTemplate in class EfxBaseListener

Parameters:

ctx - the parse tree

exitStandardLabelReference

public void exitStandardLabelReference(EfxParser.StandardLabelReferenceContext ctx)

Label Blocks #{...}

Specified by:

exitStandardLabelReference in interface EfxListener

Overrides:

exitStandardLabelReference in class EfxBaseListener

Parameters:

ctx - the parse tree

exitShorthandBtLabelReference

public void exitShorthandBtLabelReference(EfxParser.ShorthandBtLabelReferenceContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by the shorthandBtLabelReference labeled alternative in EfxParser.labelBlock().

The default implementation does nothing.

Specified by:

exitShorthandBtLabelReference in interface EfxListener

Overrides:

exitShorthandBtLabelReference in class EfxBaseListener

Parameters:

ctx - the parse tree

exitShorthandFieldLabelReference

public void exitShorthandFieldLabelReference(EfxParser.ShorthandFieldLabelReferenceContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by the shorthandFieldLabelReference labeled alternative in EfxParser.labelBlock().

The default implementation does nothing.

Specified by:

exitShorthandFieldLabelReference in interface EfxListener

Overrides:

exitShorthandFieldLabelReference in class EfxBaseListener

Parameters:

ctx - the parse tree

exitShorthandIndirectLabelReference

public void exitShorthandIndirectLabelReference(EfxParser.ShorthandIndirectLabelReferenceContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by the shorthandIndirectLabelReference labeled alternative in EfxParser.labelBlock().

The default implementation does nothing.

Specified by:

exitShorthandIndirectLabelReference in interface EfxListener

Overrides:

exitShorthandIndirectLabelReference in class EfxBaseListener

Parameters:

ctx - the parse tree

exitShorthandLabelReferenceFromContext

public void exitShorthandLabelReferenceFromContext(EfxParser.ShorthandLabelReferenceFromContextContext ctx)

Handles the #{labelType} shorthand syntax which renders the label of the Field or Node declared as the context. If the labelType is 'value', then the label depends on the field's value and is rendered according to the field's type. The assetType is inferred from the Field or Node declared as context.

Specified by:

exitShorthandLabelReferenceFromContext in interface EfxListener

Overrides:

exitShorthandLabelReferenceFromContext in class EfxBaseListener

Parameters:

ctx - the parse tree

exitShorthandIndirectLabelReferenceFromContextField

public void exitShorthandIndirectLabelReferenceFromContextField(EfxParser.ShorthandIndirectLabelReferenceFromContextFieldContext ctx)

Handles the #value shorthand syntax which renders the label corresponding to the value of the the field declared as the context of the current line of the template. This shorthand syntax is only supported for fields of type 'code' or 'indicator'.

Specified by:

exitShorthandIndirectLabelReferenceFromContextField in interface EfxListener

Overrides:

exitShorthandIndirectLabelReferenceFromContextField in class EfxBaseListener

Parameters:

ctx - the parse tree

exitAssetType

public void exitAssetType(EfxParser.AssetTypeContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by EfxParser.assetType().

The default implementation does nothing.

Specified by:

exitAssetType in interface EfxListener

Overrides:

exitAssetType in class EfxBaseListener

Parameters:

ctx - the parse tree

exitLabelType

public void exitLabelType(EfxParser.LabelTypeContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by EfxParser.labelType().

The default implementation does nothing.

Specified by:

exitLabelType in interface EfxListener

Overrides:

exitLabelType in class EfxBaseListener

Parameters:

ctx - the parse tree

exitAssetId

public void exitAssetId(EfxParser.AssetIdContext ctx)

Description copied from class: EfxBaseListener

Exit a parse tree produced by EfxParser.assetId().

The default implementation does nothing.

Specified by:

exitAssetId in interface EfxListener

Overrides:

exitAssetId in class EfxBaseListener

Parameters:

ctx - the parse tree

exitStandardExpressionBlock

public void exitStandardExpressionBlock(EfxParser.StandardExpressionBlockContext ctx)

Handles a standard expression block in a template line. Most of the work is done by the base class EfxExpressionTranslator. After the expression is translated, the result is passed through the renderer.

Specified by:

exitStandardExpressionBlock in interface EfxListener

Overrides:

exitStandardExpressionBlock in class EfxBaseListener

Parameters:

ctx - the parse tree

exitShorthandFieldValueReferenceFromContextField

public void exitShorthandFieldValueReferenceFromContextField(EfxParser.ShorthandFieldValueReferenceFromContextFieldContext ctx)

Handles the $value shorthand syntax which renders the value of the field declared as context in the current line of the template.

Specified by:

exitShorthandFieldValueReferenceFromContextField in interface EfxListener

Overrides:

exitShorthandFieldValueReferenceFromContextField in class EfxBaseListener

Parameters:

ctx - the parse tree

exitContextDeclarationBlock

public void exitContextDeclarationBlock(EfxParser.ContextDeclarationBlockContext ctx)

This method changes the current EFX context. The EFX context is always assumed to be either a Field or a Node. Any predicate included in the EFX context declaration is not relevant and is ignored.

Specified by:

exitContextDeclarationBlock in interface EfxListener

Overrides:

exitContextDeclarationBlock in class EfxBaseListener

Parameters:

ctx - the parse tree

exitTemplateLine

public void exitTemplateLine(EfxParser.TemplateLineContext ctx)

Template lines

Specified by:

exitTemplateLine in interface EfxListener

Overrides:

exitTemplateLine in class EfxBaseListener

Parameters:

ctx - the parse tree