com.tridion.tcdl

Class TCDLEngine

java.lang.Object

com.tridion.tcdl.TCDLEngine

All Implemented Interfaces:

com.tridion.configuration.Configurable, TCDLTagsProcessor

Direct Known Subclasses:

TCDLRenderer, TCDLTransformer

public abstract class TCDLEngine
extends Object
implements TCDLTagsProcessor, com.tridion.configuration.Configurable

Uses the TCDL engine to transform or to render tcdl enabled content. It allows for the configuration of tag handlers via the Configuration mechanism

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TCDLEngine(TCDLMode mode) Creates a new TCDLEngine in a certain mode.

Method Summary

Modifier and Type	Method and Description
void	configure(com.tridion.configuration.Configuration configuration) Configures the environment for running the TCDL engine.
protected TransformContext	createTransformContext(Map<String,String> variables) Creates a new transform context.
protected DocumentBuilder	getDocumentBuilder()
protected TagHandlerRegistry	getTagHandlerRegistry() Currently for each transformation the registry is re-initialized.
boolean	isLanguageOverridden() Returns true if the output language is set from config.
void	setCodeBlockMarkers(String startMarker, String endMarker) Programmatically set the code block markers.
void	setProperty(String key, String value) Programmatically set a TransformContent property.
void	setTargetLanguage(int languageId) Sets the target language for the transformation, but only if a language was not set via configuration properties (so configuration can provide an override).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tridion.tcdl.TCDLTagsProcessor

process

Constructor Detail

TCDLEngine

protected TCDLEngine(TCDLMode mode)

Creates a new TCDLEngine in a certain mode.

Parameters:

mode - The mode in which this TCDLEngine is.

Method Detail

getDocumentBuilder

protected DocumentBuilder getDocumentBuilder()

configure

public void configure(com.tridion.configuration.Configuration configuration)
               throws com.tridion.configuration.ConfigurationException

Configures the environment for running the TCDL engine. This consists of 4 parts: - The DocumentBuilder to use (optional, the DefaultDocumentBuilder is used when omitted) - The Language to use for the built-in TCDL tags (.NET by default) - Properties to initialize the TransformContext with - The tag and TagHandler definitions. These can be configured inline or using external 'bundle' files (These 'bundles' files are searched on the classpath. The bundle files may only define Tag and TransformContext properties, but otherwise use the same configuration format)

Specified by:

configure in interface com.tridion.configuration.Configurable

Parameters:

configuration - The configuration object from which to read any possible customizations regarding the document builder, the contextProperties, the tags or the start/end markers.

Throws:

com.tridion.configuration.ConfigurationException - If something went wrong while trying to retrieve values for.

setCodeBlockMarkers

public void setCodeBlockMarkers(String startMarker,
                                String endMarker)

Programmatically set the code block markers.

Parameters:

startMarker - marker to use for starting a code block

endMarker - marker to use to end a code block

setProperty

public void setProperty(String key,
                        String value)

Programmatically set a TransformContent property.

Parameters:

key - name of the property to set.

value - the property value.

isLanguageOverridden

public boolean isLanguageOverridden()

Returns true if the output language is set from config. In this case the language should never be set to the publication target language or DCP output format language.

Returns:

true if language is overridden.

setTargetLanguage

public void setTargetLanguage(int languageId)

Sets the target language for the transformation, but only if a language was not set via configuration properties (so configuration can provide an override). The default value for the language is "dotnet". That is: if the languageId parameter is not recognized or if it's ProcessorInstructions.TARGET_LANGUAGE_TCDL then we the the language to "dotnet". NOTE: the target language is only used when the mode is TRANSFORMATION. The when in RENDERER mode we just ignore the target language.

Specified by:

setTargetLanguage in interface TCDLTagsProcessor

Parameters:

languageId - The id of the target language to be set for this transformation.

See Also:

Constants}.

getTagHandlerRegistry

protected TagHandlerRegistry getTagHandlerRegistry()

Currently for each transformation the registry is re-initialized. This can be a future optimization.

Returns:

the tag handler.

createTransformContext

protected TransformContext createTransformContext(Map<String,String> variables)

Creates a new transform context. This method actually only exists for unit test purposes.

Parameters:

variables - The variables to use during rendering or transformations

Returns:

a new transform context initialized with configured settings and properties