com.tridion.tcdl.transformer

Class TCDLLegacyTransformProcessor

java.lang.Object

com.tridion.tcdl.transformer.TCDLLegacyTransformProcessor

All Implemented Interfaces:

com.tridion.configuration.Configurable, TCDLProcessor

Deprecated.

to be removed eventually.

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

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
TCDLLegacyTransformProcessor(String className) Deprecated. Creates a TCDLTransformProcessor with the configured name of the transformer to use If this transformer implements the old interface (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) Deprecated.
void	setDynamicComponentLanguage(String dcpLanguage) Deprecated.
void	setTargetLanguage(Integer targetLanguage) Deprecated.
File	transformItem(String itemURI, File transformFile, String charsetName, TransformerBinaryStorage binaryStorage) Deprecated. 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

TCDLLegacyTransformProcessor

public TCDLLegacyTransformProcessor(String className)
                             throws ProcessingException

Deprecated.

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

Parameters:

className - the class name 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

Deprecated.

Specified by:

configure in interface com.tridion.configuration.Configurable

Specified by:

configure in interface TCDLProcessor

Throws:

com.tridion.configuration.ConfigurationException

setDynamicComponentLanguage

public void setDynamicComponentLanguage(String dcpLanguage)

Deprecated.

Specified by:

setDynamicComponentLanguage in interface TCDLProcessor

setTargetLanguage

public void setTargetLanguage(Integer targetLanguage)

Deprecated.

Specified by:

setTargetLanguage in interface TCDLProcessor

transformItem

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

Deprecated.

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