com.tridion.transformer

Class TCDLDefaultTransformer

java.lang.Object

com.tridion.tcdl.TCDLEngine

com.tridion.tcdl.TCDLTransformer

com.tridion.transformer.TCDLDefaultTransformer

All Implemented Interfaces:

com.tridion.configuration.Configurable, AdditionalTagsProcessing, TCDLTagsProcessor, FileTransformer

Direct Known Subclasses:

TCDLTransformer

public class TCDLDefaultTransformer
extends TCDLTransformer
implements FileTransformer

Uses the TCDL engine to transform tcdl enabled content. It allows for the configuration of tag handlers via the Configuration mechanism It implements Transformer making it available to the deployer via the TCDLTransformProcessor

Constructor Summary

Constructors

Constructor and Description
TCDLDefaultTransformer() Creates a new TCDLDefaultTransformer.

Method Summary

Modifier and Type	Method and Description
File	transform(String itemURI, File sourceFile, String charsetName, File targetDirectory) Deprecated. Use transform(String, File, String, File, TransformerBinaryStorage).
File	transform(String itemURI, File sourceFile, String charsetName, File targetDirectory, TransformerBinaryStorage binaryStorage) Transforms TCDL enabled content from [sourceFile] optionally using the [charsetName] for its encoding.
void	transform(String itemURI, String input, Writer target) Transforms TCDL enabled content from the [input] String and writes the result to the [target].

Methods inherited from class com.tridion.tcdl.TCDLTransformer

process, process

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.transformer.FileTransformer

setTargetLanguage

Methods inherited from interface com.tridion.tcdl.TCDLTagsProcessor

setTargetLanguage

Constructor Detail

TCDLDefaultTransformer

public TCDLDefaultTransformer()

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

Method Detail

transform

public File transform(String itemURI,
                      File sourceFile,
                      String charsetName,
                      File targetDirectory,
                      TransformerBinaryStorage binaryStorage)
               throws ProcessingException

Transforms TCDL enabled content from [sourceFile] optionally using the [charsetName] for its encoding. The result is written into the [targetDirectory] using the original filename. Again using the optional [charsetName].

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

Specified by:

transform in interface FileTransformer

Parameters:

itemURI - uri of the item being transformed

sourceFile - the possibly TCDL enabled file to be transformed

charsetName - when non-null the charsetName will be used for reading/writing the files

targetDirectory - directory in which the result file must be stored

binaryStorage - storage implementation

Returns:

the reference to the output file that was created

Throws:

ProcessingException - when the source could not be transformed

transform

public void transform(String itemURI,
                      String input,
                      Writer target)
               throws TCDLTransformerException

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.

Parameters:

itemURI - uri of the item being transformed

input - TCDL enabled content

target - Writer to write output to

Throws:

TCDLTransformerException - when the source could not be transformed

transform

@Deprecated
public File transform(String itemURI,
                                   File sourceFile,
                                   String charsetName,
                                   File targetDirectory)
                            throws ProcessingException

Deprecated. Use transform(String, File, String, File, TransformerBinaryStorage).

Transforms TCDL enabled content from [sourceFile] optionally using the [charsetName] for its encoding. The result is written into the [targetDirectory] using the original filename. Again using the optional [charsetName].

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

Specified by:

transform in interface FileTransformer

Parameters:

itemURI - uri of the item being transformed

sourceFile - the possibly TCDL enabled file to be transformed

charsetName - when non-null the charsetName will be used for reading/writing the files

targetDirectory - directory in which the result file must be stored

Returns:

the reference to the output file that was created

Throws:

ProcessingException - when the source could not be transformed