com.tridion.tcdl

Class TCDLTransformer

java.lang.Object

com.tridion.tcdl.TCDLEngine

com.tridion.tcdl.TCDLTransformer

All Implemented Interfaces:

com.tridion.configuration.Configurable, AdditionalTagsProcessing, TCDLTagsProcessor

Direct Known Subclasses:

TCDLDefaultTransformer

public class TCDLTransformer
extends TCDLEngine
implements AdditionalTagsProcessing

Uses the TCDL engine to transform tcdl enabled content. It allows for the configuration of tag handlers via the Configuration mechanism.

Constructor Summary

Constructors

Constructor and Description
TCDLTransformer() Creates a new TCDLTransformer.

Method Summary

Modifier and Type	Method and Description
void	process(String itemURI, String input, Map<String,String> variablesMap, Writer target) Transforms 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) Transforms or renders TCDL enabled content from the [input] String and writes the result to the [target].

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

TCDLTransformer

public TCDLTransformer()

Creates a new TCDLTransformer. Required for Class.forName(..).newInstance() usage

Method Detail

process

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

Transforms 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. Not used by the code in this class!!!

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

Description copied from interface: AdditionalTagsProcessing

Transforms or 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 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 - execution arguments

Throws:

ProcessingException - when the source could not be transformed