com.tridion.tcdl

Class TCDLProcessor

java.lang.Object

com.tridion.tcdl.TCDLProcessor

All Implemented Interfaces:

com.tridion.configuration.Configurable

public class TCDLProcessor
extends Object
implements com.tridion.configuration.Configurable

This class is the central class where all tcdl transformations and rendering happen.

Note that this class is using the transformer and renderer configured in the cd_deployer respectively cd_storage configuration file (if are defined in it) or {@link TCDLRenderer) and {@link TCDLTransformer) by default. If you do not care about the (possible) custom configured transformer and renderer from the configuration file you can use directly the {@link TCDLRenderer) or the {@link TCDLTransformer).

Method Summary

Modifier and Type	Method and Description
void	configure(com.tridion.configuration.Configuration tcdlEngineConfiguration)
static void	flushInstance()
static TCDLProcessor	getInstance()
void	process(String itemURI, String input, Map<String,String> variablesMap, Writer target, TCDLMode mode, String dcpLanguage) This method processes an item passed to it.
void	process(String itemURI, String input, Map<String,String> variablesMap, Writer target, TCDLMode mode, String dcpLanguage, GlobalExecutionArguments args) This method processes an item passed to it.

Methods inherited from class java.lang.Object

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

Method Detail

configure

public void configure(com.tridion.configuration.Configuration tcdlEngineConfiguration)
               throws com.tridion.configuration.ConfigurationException

Specified by:

configure in interface com.tridion.configuration.Configurable

Throws:

com.tridion.configuration.ConfigurationException

getInstance

public static TCDLProcessor getInstance()

flushInstance

public static void flushInstance()

process

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

This method processes an item passed to it. It renders or transforms any TCDL tags in the input string into the configured target output language.

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 - If the content could not be rendered/transformed.

process

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

This method processes an item passed to it. It renders or transforms any TCDL tags in the input string into the configured target output language.

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.

Throws:

ProcessingException - If the content could not be rendered/transformed.