com.tridion.tcdl

Class TCDLRenderer

java.lang.Object

com.tridion.tcdl.TCDLEngine

com.tridion.tcdl.TCDLRenderer

All Implemented Interfaces:

com.tridion.configuration.Configurable, AdditionalTagsProcessing, TCDLTagsProcessor

public class TCDLRenderer
extends TCDLEngine
implements AdditionalTagsProcessing

Uses the TCDL engine to render tcdl enabled content. It allows for the configuration of taghandlers via the Configuration mechanism.

Constructor Summary

Constructors

Constructor and Description
TCDLRenderer() Creates a new TCDLRenderer.

Method Summary

Modifier and Type	Method and Description
void	process(String itemURI, String input, Map<String,String> variablesMap, Writer target) Renders TCDL enabled content from the [input] String and writes the result to the [target].
void	process(String itemURI, String input, Map<String,String> variablesMap, Writer target, GlobalExecutionArguments args) Renders TCDL tags with additional execution parameters which assigned to TransformContext.

Methods inherited from class com.tridion.tcdl.TCDLEngine

configure, createTransformContext, getDocumentBuilder, getTagHandlerRegistry, isLanguageOverridden, setCodeBlockMarkers, setProperty, setTargetLanguage

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tridion.tcdl.TCDLTagsProcessor

setTargetLanguage

Constructor Detail

TCDLRenderer

public TCDLRenderer()

Creates a new TCDLRenderer.

Method Detail

process

public void process(String itemURI,
                    String input,
                    Map<String,String> variablesMap,
                    Writer target)
             throws ProcessingException

Renders TCDL enabled content from the [input] String and writes the result to the [target].

Note that when you call this method multiple times on the same instance, the same configuration and (programmatically) set properties will be used.

Specified by:

process in interface TCDLTagsProcessor

Parameters:

itemURI - uri of the item being transformed

input - TCDL enabled content

variablesMap - Map with variables to replace while parsing TCDL.

target - Writer to write output to

Throws:

ProcessingException - when the source could not be transformed

process

public void process(String itemURI,
                    String input,
                    Map<String,String> variablesMap,
                    Writer target,
                    GlobalExecutionArguments args)
             throws ProcessingException

Renders TCDL tags with additional execution parameters which assigned to TransformContext.

Specified by:

process in interface AdditionalTagsProcessing

Parameters:

itemURI - uri of the item being transformed

input - TCDL enabled content

variablesMap - Map with variables to replace while parsing TCDL. Note that this is only used when rendering.

target - Writer to write output to

args - additional execution arguments

Throws:

ProcessingException - when the source could not be transformed