com.tridion.tcdl

Interface TagMetaEventListener

public interface TagMetaEventListener

Optional interface for implementation by TagHandlers to get notified of meta events, such as the start and end of processing a TCDL document. This allows a Tag implementation to do preparation and finalization work based on all tags encountered.

For each TagHandler implementing this interface, a single instance is created and used throughout the processing of a TCDL enabled item. For more information on the lifecycle of Tags see TagHandler

Method Summary

Modifier and Type	Method and Description
void	endDocument(TransformContext context, OutputDocument target) Called by the TCDLParser just after finishing the parsing process without errors.
void	startDocument(TransformContext context, OutputDocument target) Called by the TCDLParser just before starting the parsing process Note that the TransformContext may not have all information during the startDocument, especially the information that is derived from the ContentHeader tag (including the uri of the item being transformed).

Method Detail

startDocument

void startDocument(TransformContext context,
                   OutputDocument target)
            throws TCDLTransformerException

Called by the TCDLParser just before starting the parsing process Note that the TransformContext may not have all information during the startDocument, especially the information that is derived from the ContentHeader tag (including the uri of the item being transformed).

Parameters:

context - TransformContext offering access to context attributes

target - OutputDocument for setting supporting information to build the final document

Throws:

TCDLTransformerException - if the processing should not continue for some reason.

TCDLTransformerException

endDocument

void endDocument(TransformContext context,
                 OutputDocument target)
          throws TCDLTransformerException

Called by the TCDLParser just after finishing the parsing process without errors. When errors occur during the transformation this method is not called

Parameters:

context - TransformContext offering access to context attributes

target - OutputDocument for setting supporting information to build the final document

Throws:

TCDLTransformerException - if the processing should not continue for some reason.

TCDLTransformerException