com.tridion.transformer

Class TransformProcessor

java.lang.Object

com.tridion.transformer.TransformProcessor

public class TransformProcessor
extends Object

The TransformProcessor class is the central class through which all transformations take place. This is the class called from outside of this package, to allow transformation to take place.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
TransformProcessor()
TransformProcessor(String transformerClassName) Constructs a transformation TransformProcessor class, generating a Transformer instance, for use by all of the classes in the com.tridion.transformer package.

Method Summary

Modifier and Type	Method and Description
static Transformer	getTransformer(String transformerClassName) Get an instance of the Transformer class using the class name passed as an argument.
File	transformItem(File transformFile, Function<File,byte[]> fileReader, BiConsumer<File,byte[]> fileWriter) This method processes an item passed to it.
File	transformItem(File transformFile, String charsetName, Function<File,byte[]> fileReader, BiConsumer<File,byte[]> fileWriter) 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

Field Detail

DEFAULT_CLASS_NAME

protected static final String DEFAULT_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

TransformProcessor

public TransformProcessor()
                   throws TCDLTransformerException

Throws:

TCDLTransformerException

TransformProcessor

public TransformProcessor(String transformerClassName)
                   throws TCDLTransformerException

Constructs a transformation TransformProcessor class, generating a Transformer instance, for use by all of the classes in the com.tridion.transformer package.

Parameters:

transformerClassName - The fully qualified classname of a class which extends com.tridion.transformer.Transformer, providing the mapping to generate a specific target output language.

Throws:

TCDLTransformerException

Method Detail

getTransformer

public static Transformer getTransformer(String transformerClassName)
                                  throws TCDLTransformerException

Get an instance of the Transformer class using the class name passed as an argument. If the transformer field has not been set, then this will also this field to the Transformer class instantiated.

Parameters:

transformerClassName - The name of the class to instantiate.

Returns:

An instance of a Transformer class.

Throws:

TCDLTransformerException

transformItem

public File transformItem(File transformFile,
                          String charsetName,
                          Function<File,byte[]> fileReader,
                          BiConsumer<File,byte[]> fileWriter)
                   throws TCDLTransformerException

This method processes an item passed to it. It reads the file with the name fileName using the default platform encoding, in the location itemLocation, and transforms any Tridion Content Delivery Intermediate Language tags in the item into the configured target output language.

Parameters:

transformFile - The filename of the item.

charsetName - charset of content.

fileReader - reads content of provided file.

fileWriter - writes content to provided file.

Returns:

The file containing of the transformed item.

Throws:

TCDLTransformerException

transformItem

public File transformItem(File transformFile,
                          Function<File,byte[]> fileReader,
                          BiConsumer<File,byte[]> fileWriter)
                   throws TCDLTransformerException

This method processes an item passed to it. It reads the file with the name fileName using the default platform encoding, in the location itemLocation, and transforms any Tridion Content Delivery Intermediate Language tags in the item into the configured target output language.

Parameters:

transformFile - The filename of the item.

fileReader - reads content of provided file.

fileWriter - writes content to provided file.

Returns:

The file containing of the transformed item.

Throws:

TCDLTransformerException