com.tridion.tcdl

Interface DocumentBuilder

All Known Implementing Classes:

DefaultDocumentBuilder

public interface DocumentBuilder

Responsible for building the final document. During processing of TCDL content, the content and code that is produced by the tags is injected directly in the body. However specifically when generating code, such code will have dependencies on imports, page directives and variable declarations. The DocumentBuilder combines these aspects with the body to produce the final document.

In almost all situations the DefaultDocumentBuilder will be the only implementation ever needed of a DocumentBuilder, but for rare cases it is possible to implement the DocumentBuilder differently.

Method Summary

Modifier and Type	Method and Description
void	buildDocument(TransformContext context, OutputDocument source, Writer target) Responsible for serializing the output document to the [target] Writer.

Method Detail

buildDocument

void buildDocument(TransformContext context,
                   OutputDocument source,
                   Writer target)
            throws TCDLTransformerException

Responsible for serializing the output document to the [target] Writer.

Parameters:

context - TransformContext offering access to context attributes

source - OutputDocument that must be serialized

target - Writer to serialize to

Throws:

TCDLTransformerException - when an error occurs during serialization of the output document

TCDLTransformerException