com.tridion.transformer

Class AbstractTransformer

java.lang.Object

com.tridion.transformer.AbstractTransformer

All Implemented Interfaces:

Transformer

Direct Known Subclasses:

ASPDotNETTransformer

Deprecated.

Legacy implementation.

public abstract class AbstractTransformer
extends Object
implements Transformer

This is the base abstract class for transforming Intermediate language into a target output language. You can extend this class if you want to implement your own output language.

Constructor Summary

Constructors

Constructor and Description
AbstractTransformer() Deprecated.

Method Summary

Modifier and Type	Method and Description
abstract StringBuffer	getContentsFromTag(TCDLTag currentTag, String inputItem, TransformContext context) Deprecated. This is a recursive function which reads the contents of a particular tag, then recurses any child tags this tag has, calling the necessary transformer to deal with the contents of the tag.
protected StringBuffer	getFullContentsFromTag(TCDLTag currentTag, String inputItem, TransformContext context) Deprecated. This is a recursive function which reads the contents of a particular tag, then recurses any child tags this tag has, calling the necessary transformer to deal with the contents of the tag.
StringBuffer	startProcessingItem(String inputItem, TreeMap dataModel, TransformContext context) Deprecated. This is the entry point for transforming a text containing TCDL.
abstract StringBuffer	transformFooter(StringBuffer footer) Deprecated. Generate the final output of a footer for a TransformContext.
abstract StringBuffer	transformHeader(StringBuffer header) Deprecated. Generate the final output of a Header for a TransformContext.
abstract String	transformTag(TCDLTag tag, TransformContext context) Deprecated. This is the method which will transforms the attributes and contents of the tag into the configured target output language.

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.Transformer

assembleContent

Constructor Detail

AbstractTransformer

public AbstractTransformer()

Deprecated.

Method Detail

startProcessingItem

public StringBuffer startProcessingItem(String inputItem,
                                        TreeMap dataModel,
                                        TransformContext context)

Deprecated.

This is the entry point for transforming a text containing TCDL. This method is called by the TransformProcessor, based on the file which it is processing. This method scans the file, copying everything not contained in tags, and transforming the rest, based on the Data Model created by the TCDLParser. It also updates the TransformContext, ensuring that the correct headers and footers are generated.

The dataModel parameter is a TreeMap containing TCDLTag objects, using an Integer representing the first index of the start of the TCDLTag found in the input stream.

Specified by:

startProcessingItem in interface Transformer

Parameters:

inputItem - A string containing the file to be processed.

dataModel - A TreeMap containing TCDLTags, forming a representation of the data model generated by the TCDL.

context - The context of the item being processed. It can be used to generate the correct headers and footers.

Returns:

A StringBuffer containing transformed content. This can then be added to the headers and footers, and written to a file.

transformTag

public abstract String transformTag(TCDLTag tag,
                                    TransformContext context)

Deprecated.

This is the method which will transforms the attributes and contents of the tag into the configured target output language. This method gets the configured AbstractTransformer class from the TransformProcessor, and then calls the appropriate transformer method for the tag, based on the name field. The attributes field is passed to the appropriate transformer method, together with the tagContents field. The AbstractTransformer class then returns a formatted string.

Specified by:

transformTag in interface Transformer

Returns:

A formatted string containing the correct code for the target output language.

getContentsFromTag

public abstract StringBuffer getContentsFromTag(TCDLTag currentTag,
                                                String inputItem,
                                                TransformContext context)

Deprecated.

This is a recursive function which reads the contents of a particular tag, then recurses any child tags this tag has, calling the necessary transformer to deal with the contents of the tag.

Specified by:

getContentsFromTag in interface Transformer

Parameters:

currentTag - A TCDLTag which you want to transform.

inputItem - A string from which to copy the non-transformable parts from.

Returns:

The transformed content.

transformHeader

public abstract StringBuffer transformHeader(StringBuffer header)

Deprecated.

Generate the final output of a Header for a TransformContext.

Specified by:

transformHeader in interface Transformer

Parameters:

header - The contents of the header.

Returns:

The transformed contents (e.g. including start and end code blocks, for example).

transformFooter

public abstract StringBuffer transformFooter(StringBuffer footer)

Deprecated.

Generate the final output of a footer for a TransformContext.

Specified by:

transformFooter in interface Transformer

Parameters:

footer - The contents of the footer.

Returns:

The transformed contents (e.g. including start and end code blocks, for example).

getFullContentsFromTag

protected StringBuffer getFullContentsFromTag(TCDLTag currentTag,
                                              String inputItem,
                                              TransformContext context)

Deprecated.

This is a recursive function which reads the contents of a particular tag, then recurses any child tags this tag has, calling the necessary transformer to deal with the contents of the tag.

Parameters:

currentTag - A TCDLTag which you want to transform.

inputItem - A string from which to copy the non-transformable parts from.

Returns:

The transformed content.