com.tridion.tcdl

Class TCDLParser

java.lang.Object

com.tridion.tcdl.TCDLParser

public class TCDLParser
extends Object

Scans string based input for XML-like tags given a list of namespaces. For each encountered tag a Tag object is created including the parsed set of attributes specified in the tag. Entities in these attribute values are resolved, but only xml standard entities and numbered entities can be used.

A TCDLParserEventListener is used to notify interested party of start tag, end tag and element data events, so actual interpretation of tags can be handled elsewhere.

Constructor Summary

Constructors

Constructor and Description
TCDLParser(Collection<String> namespaces) Constructs the TCDLParser with the given (string based) list of namespaces to scan for.
TCDLParser(Collection<String> namespaces, Map<String,String> variables) Constructs the TCDLParser with the given (string based) list of namespaces to scan for.

Method Summary

Modifier and Type	Method and Description
void	parse(TCDLParserEventListener dispatch, String input) Process the content of [input] and dispatches start/end tag, element data, start/end document events to the TCDLParserEventListener [dispatch].

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TCDLParser

public TCDLParser(Collection<String> namespaces,
                  Map<String,String> variables)
           throws TCDLTransformerException

Constructs the TCDLParser with the given (string based) list of namespaces to scan for. The TCDLParser instance may be reused to process multiple documents and can be used concurrently.

Parameters:

namespaces - A string based collection of namespace prefixes to scan for.

variables - The variables to replace while parsing TCDL.

Throws:

TCDLTransformerException - When one of the namespaces contains illegal characters this may get thrown or the variable regular expression is wrong.

TCDLTransformerException

TCDLParser

public TCDLParser(Collection<String> namespaces)
           throws TCDLTransformerException

Constructs the TCDLParser with the given (string based) list of namespaces to scan for. The TCDLParser instance may be reused to process multiple documents and can be used concurrently.

Parameters:

namespaces - A string based collection of namespace prefixes to scan for.

Throws:

TCDLTransformerException - When one of the namespaces contains illegal characters this may get thrown

TCDLTransformerException

Method Detail

parse

public void parse(TCDLParserEventListener dispatch,
                  String input)
           throws TCDLTransformerException

Process the content of [input] and dispatches start/end tag, element data, start/end document events to the TCDLParserEventListener [dispatch].

Parameters:

dispatch - Recipient of the parser events

input - TCDL enabled input to scan for tags

Throws:

TCDLTransformerException - if the processing of the content could not be completed successfully