com.tridion.transformer

Interface FileTransformer

All Known Implementing Classes:

TCDLDefaultTransformer, TCDLTransformer

public interface FileTransformer

Using a transformer files can be transformed in to a different file. Together with the TCDLTransformProcessor this allows for the transformation of files just before they are deployed.

Method Summary

Modifier and Type	Method and Description
void	setTargetLanguage(int languageId) Set the target language as indicated by the deployer meta data.
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 item [itemURI] from [sourceFile] using [charsetName] into the targetDirectory, returning the created File.

Method Detail

setTargetLanguage

void setTargetLanguage(int languageId)

Set the target language as indicated by the deployer meta data. This is either a supported scripting language for derived from the DCP "output format" field (same way as ComponentPresentationAssembler does) or the target language of the publication. The possible values are defined in ProcessorInstructions.TARGET_LANGUAGE_XXX constants.

Parameters:

languageId - target language for the transformation

transform

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

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

Transforms item [itemURI] from [sourceFile] using [charsetName] into the targetDirectory, returning the created File.

Parameters:

itemURI - uri of the item being transformed

sourceFile - source file to transform

charsetName - encoding of the source and target file

targetDirectory - directory in which the result file must be produced

Returns:

File referencing the produced output file. Never null

Throws:

ProcessingException - when an error occurred during the transformation

transform

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

Transforms item [itemURI] from [sourceFile] using [charsetName] into the targetDirectory, returning the created File.

Parameters:

itemURI - uri of the item being transformed

sourceFile - source file to transform

charsetName - encoding of the source and target file

targetDirectory - directory in which the result file must be produced

binaryStorage - storage implementation

Returns:

File referencing the produced output file. Never null

Throws:

ProcessingException - when an error occurred during the transformation