com.tridion.tcdl.transformer

Class TCDLTransformProcessor

java.lang.Object

com.tridion.tcdl.transformer.TCDLTransformProcessor

All Implemented Interfaces:

com.tridion.configuration.Configurable, TCDLProcessor

public class TCDLTransformProcessor
extends Object
implements TCDLProcessor

The TCDLTransformProcessor class is the central class through which all transformations take place when called from the deployer.

Note due to the very TCDL-tied interface "Transformer" that is part of the OLD code base this class has been reworked to allow transformers to have a very generic interface instead (e.g. output = transform(source)). However, to ensure backward compatibility it is tested if a plugin class implements the OLD interface and if so, the old package is used to perform all processing.

When wanting to use TCDL elsewhere, the TCDLTransformProcessor is the main entry point for that.

Constructor Summary

Constructors

Constructor and Description
TCDLTransformProcessor(Class clazz) Creates a TCDLTransformProcessor with the configured name of the transformer to use If this transformer implements the old interface (com.tridion.transformer.Transformer), this instance will delegate the transformation the old API.

Method Summary

Modifier and Type	Method and Description
void	configure(com.tridion.configuration.Configuration configuration) This is only intended to run within the deployer and the configuration is expected to be the deployer config.
void	setDynamicComponentLanguage(String dcpLanguage) When the content that will be processed is a DCP, this method gets called by the deployer to indicate the target language of the DCP.
void	setTargetLanguage(Integer targetLanguage)
File	transformItem(String itemURI, File transformFile, String charsetName, TransformerBinaryStorage binaryStorage) 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

Constructor Detail

TCDLTransformProcessor

public TCDLTransformProcessor(Class clazz)
                       throws ProcessingException

Creates a TCDLTransformProcessor with the configured name of the transformer to use If this transformer implements the old interface (com.tridion.transformer.Transformer), this instance will delegate the transformation the old API.

Parameters:

clazz - the class for the Transformer implementation.

Throws:

ProcessingException - in case of error.

Method Detail

configure

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

This is only intended to run within the deployer and the configuration is expected to be the deployer config. Since the Transformer is specified more than once in the deployer config, the actual tag configuration and stuff is read from a top level configuration element to prevent having to list the configuration more than once.

Specified by:

configure in interface com.tridion.configuration.Configurable

Specified by:

configure in interface TCDLProcessor

Parameters:

configuration - configuration to be used

Throws:

com.tridion.configuration.ConfigurationException

setDynamicComponentLanguage

public void setDynamicComponentLanguage(String dcpLanguage)

When the content that will be processed is a DCP, this method gets called by the deployer to indicate the target language of the DCP. This language may be different from the configured language.

Specified by:

setDynamicComponentLanguage in interface TCDLProcessor

Parameters:

dcpLanguage - language used

setTargetLanguage

public void setTargetLanguage(Integer targetLanguage)

Specified by:

setTargetLanguage in interface TCDLProcessor

transformItem

public File transformItem(String itemURI,
                          File transformFile,
                          String charsetName,
                          TransformerBinaryStorage binaryStorage)
                   throws ProcessingException

This method processes an item passed to it. It reads the file with the name fileName using the default platform encoding or the given charsetName, and transforms any TCDL tags in the item into the configured target output language.

Specified by:

transformItem in interface TCDLProcessor

Parameters:

itemURI - uri of the item being transformed

transformFile - The filename of the of the source file.

charsetName - when non-null indicates the encoding of the source and target file. When null platform encoding is used

binaryStorage - Storage implementation

Returns:

The file containing of the transformed item.

Throws:

ProcessingException