TransformContext (Build - API Documentation 11.6.0-1104 API)

java.lang.Object
- com.tridion.tcdl.TransformContext

```
public class TransformContext
extends Object
```
A TransformContext is available during the processing of a TCDL file. Each TransformContext is specific to a single transformation. It contains key/value type properties. Which in turn can be combination of both static and dynamic properties. E.g. properties that are set in configuration files and properties set by tags while transforming TCDL data
Besides general properties, the context contains information about the data being transformed; e.g. the URI of the page or component and derived from that the publication id.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PARAM_TAG_POSTPROCESSORS` Tag post-processors parameter.
`static String`	`PARAM_USER` User parameter.
`static String`	`PARAM_WEB_CONTEXT` Web context parameter.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`TransformContext(String codeBlockStartMarker, String codeBlockEndMarker)` Creates a transform context using the given markers for inline code blocks.
`protected`	`TransformContext(String codeBlockStartMarker, String codeBlockEndMarker, Map configurationProperties, Map<String,String> renderParameters)` Creates a transform context using the given markers for inline code blocks and with the internal properties set from the [configurationProperties].

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`contains(String name)` Checks if a certain property is available.
`Object`	`get(String name, Object defaultValue)` Deprecated. As of 2013 SP1 release, replaced by `getProperty(K, V)`
`boolean`	`getBoolean(String name, boolean defaultValue)` Deprecated. As of 2013 SP1 release, replaced by `getProperty(K, V)`
`String`	`getCodeBlockEndMarker()` Returns the configured marker to use to end a code block e.g.
`String`	`getCodeBlockStartMarker()` Returns the configured marker to use to start a code block e.g.
`TransformContext`	`getEnclosingContext()` Returns `TransformContext` of the enclosing `Tag`.
`TransformContext`	`getGlobalContext()` Returns the global `TransformContext`.
`Optional<GlobalExecutionArguments>`	`getGlobalExecutionArguments()` Get execution arguments from the context object.
`int`	`getInt(String name, int defaultValue)` Deprecated. As of 2013 SP1 release, replaced by `getProperty(K, V)`
`String`	`getItemURI()` Returns the itemURI that was set earlier or null if none was set.
`<K,T,V extends T> T`	`getProperty(K name, V defaultValue)` Returns value of the property from the contexts available.
`int`	`getPublicationId()` Returns the publication id that was derived from the itemURI or -1 if no valid itemURI was set.
`TCMURI`	`getPublicationURI()` Returns the publication URI derived from the itemURI or null if no valid itemURI was set.
`Map<String,String>`	`getRenderParameters()`
`String`	`getString(String name, String defaultValue)` Deprecated. As of 2013 SP1 release, replaced by `getProperty(K, V)`
`boolean`	`isRootContext()` Returns True if this is a Root Context.
`boolean`	`isTagBodyCodeBlock()` Returns true if resulting body from the current tag will be wrapped in an inline code block Note that this method should rarely be required for implementers of TagHandlers, all code block marking is handled by the engine.
`static TransformContext`	`nullContext()` Returns an instance of null TransformContext.
`void`	`remove(String name)` Removes property with `name` as key.
`void`	`set(String name, Object value)` Deprecated. As of 2013 SP1 release, replaced by `setGlobalProperty(K, V)`
`void`	`setBoolean(String name, boolean value)` Deprecated. As of 2013 SP1 release, replaced by `setGlobalProperty(K, V)`
`void`	`setGlobalExecutionArguments(GlobalExecutionArguments globalExecutionArguments)`
`<K,V> void`	`setGlobalProperty(K name, V value)` Sets property on the global `TransformContext`.
`void`	`setInt(String name, int value)` Deprecated. As of 2013 SP1 release, replaced by `setGlobalProperty(K, V)`
`void`	`setItemURI(String itemURI)` Sets the Item URI of the item that is being transformed.
`<K,V> void`	`setProperty(K name, V value)` Sets property on the currently active `TransformContext`.
`void`	`setString(String name, String value)` Deprecated. As of 2013 SP1 release, replaced by `setGlobalProperty(K, V)`
`protected void`	`setTagBodyIsCodeBlock(boolean inside)` The framework maintains whether the current tag body will be wrapped in a code block.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_USER
```
public static final String PARAM_USER
```
    User parameter.
    
    See Also:
    
    Constant Field Values
  - PARAM_TAG_POSTPROCESSORS
```
public static final String PARAM_TAG_POSTPROCESSORS
```
    Tag post-processors parameter.
    
    See Also:
    
    Constant Field Values
  - PARAM_WEB_CONTEXT
```
public static final String PARAM_WEB_CONTEXT
```
    Web context parameter.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TransformContext
```
protected TransformContext(String codeBlockStartMarker,
                           String codeBlockEndMarker,
                           Map configurationProperties,
                           Map<String,String> renderParameters)
```
    Creates a transform context using the given markers for inline code blocks and with the internal properties set from the [configurationProperties].
    
    Parameters:
    
    codeBlockStartMarker - marker to start an inline code block
    
    codeBlockEndMarker - marker to end an inline code block
    
    configurationProperties - properties to inherit
    
    renderParameters - The rendering parameters to be used during rendering of content
  - TransformContext
```
protected TransformContext(String codeBlockStartMarker,
                           String codeBlockEndMarker)
```
    Creates a transform context using the given markers for inline code blocks.
    
    Parameters:
    
    codeBlockStartMarker - marker to start an inline code block
    
    codeBlockEndMarker - marker to end an inline code block
- Method Detail
  - getGlobalExecutionArguments
```
public Optional<GlobalExecutionArguments> getGlobalExecutionArguments()
```
    Get execution arguments from the context object.
    
    Returns:
    
    optional with execution arguments or empty optional
  - setGlobalExecutionArguments
```
public void setGlobalExecutionArguments(GlobalExecutionArguments globalExecutionArguments)
```
  - nullContext
```
public static TransformContext nullContext()
```
    Returns an instance of null TransformContext.
  - getEnclosingContext
```
public TransformContext getEnclosingContext()
```
    Returns TransformContext of the enclosing Tag. If there is no enclosing Tag, it returns an instance of NullTransformContext.
  - getRenderParameters
```
public Map<String,String> getRenderParameters()
```
  - getCodeBlockStartMarker
```
public String getCodeBlockStartMarker()
```
    Returns the configured marker to use to start a code block e.g. <%.
    
    Returns:
    
    the configured marker to use to start a code block e.g. <%
  - getCodeBlockEndMarker
```
public String getCodeBlockEndMarker()
```
    Returns the configured marker to use to end a code block e.g. %>.
    
    Returns:
    
    Returns the configured marker to use to end a code block
  - setTagBodyIsCodeBlock
```
protected void setTagBodyIsCodeBlock(boolean inside)
```
    The framework maintains whether the current tag body will be wrapped in a code block.
    
    Parameters:
    
    inside - true when the current tag will be wrapped in a code block
  - isTagBodyCodeBlock
```
public boolean isTagBodyCodeBlock()
```
    Returns true if resulting body from the current tag will be wrapped in an inline code block Note that this method should rarely be required for implementers of TagHandlers, all code block marking is handled by the engine. The only case will be were you want to return both code and content from the same TagHandler
    
    Returns:
    
    true if resulting body from the current tag will be wrapped in an inline code block
  - getItemURI
```
public String getItemURI()
```
    Returns the itemURI that was set earlier or null if none was set.
    
    Returns:
    
    the itemURI that was set earlier or null if none was set
  - setItemURI
```
public void setItemURI(String itemURI)
```
    Sets the Item URI of the item that is being transformed. This URI is used by several of the base tags. From the URI the publication id is derived.
    
    Parameters:
    
    itemURI - URI for this transformation
  - getPublicationId
```
public int getPublicationId()
```
    Returns the publication id that was derived from the itemURI or -1 if no valid itemURI was set.
    
    Returns:
    
    the publication id that was derived from the itemURI or -1 if no valid itemURI was set
  - getPublicationURI
```
public TCMURI getPublicationURI()
```
    Returns the publication URI derived from the itemURI or null if no valid itemURI was set.
    
    Returns:
    
    the publication URI
  - contains
```
public boolean contains(String name)
```
    Checks if a certain property is available.
    
    Parameters:
    
    name - name of the property to check for
    
    Returns:
    
    true if it contains a key with this name, false otherwise.
  - remove
```
public void remove(String name)
```
    Removes property with name as key.
    
    Parameters:
    
    name - the property to remove
  - getProperty
```
public <K,T,V extends T> T getProperty(K name,
                                       V defaultValue)
```
    Returns value of the property from the contexts available.
    First of all, it performs a lookup in the active local context. If not found, it incrementally searches enclosing contexts till it reaches root context. In effect, it performs lookup in all the available enclosing contexts (including global context). If the property is not set in any context, then defaultValueis returned
    
    Type Parameters:
    
    K - type of name of the property
    
    T - type of value of the property.
    
    V - type of default value of the property. It can be subtype of the actual value stored.
    
    Parameters:
    
    name - name of the property
    
    defaultValue - default value to return when the property is not found
    
    Returns:
    
    value of the property or the defaultValue
  - setGlobalProperty
```
public <K,V> void setGlobalProperty(K name,
                                    V value)
```
    Sets property on the global TransformContext. Please note that for the transformation of a complete document, a globalTransformContext gets created, which stores state applicable for the entire transformation.
    
    Type Parameters:
    
    K - type of key of the property
    
    V - type of value of the property
    
    Parameters:
    
    name - name of the property
    
    value - value of the property
  - setProperty
```
public <K,V> void setProperty(K name,
                              V value)
```
    Sets property on the currently active TransformContext. TransformContext supports scoping, which in essence creates a local context for each Tag. setProperty gets the currently active scope/context and saves property. On the other hand, setGlobalProperty(K, V) saves property in the global context.
    
    Type Parameters:
    
    K - type of key of the property
    
    V - type of value of the property
    
    Parameters:
    
    name - name of the property
    
    value - value of the property
  - isRootContext
```
public boolean isRootContext()
```
    Returns True if this is a Root Context. Otherwise, it returns false.
  - getGlobalContext
```
public TransformContext getGlobalContext()
```
    Returns the global TransformContext.
  - setString
```
@Deprecated
public void setString(String name,
                                   String value)
```
    Deprecated. As of 2013 SP1 release, replaced by setGlobalProperty(K, V)
    
    Sets property value to a String.
    
    Parameters:
    
    name - property to retrieve
    
    value - value for the property
  - setInt
```
@Deprecated
public void setInt(String name,
                                int value)
```
    Deprecated. As of 2013 SP1 release, replaced by setGlobalProperty(K, V)
    
    Sets property value to a boolean. It uses global TransformContext to set property value.
    
    Parameters:
    
    name - property to retrieve
    
    value - value for the property
  - getInt
```
@Deprecated
public int getInt(String name,
                               int defaultValue)
```
    Deprecated. As of 2013 SP1 release, replaced by getProperty(K, V)
    
    Returns a property as an int. If the property is not set, the defaultValue is returned
    
    Parameters:
    
    name - property to retrieve
    
    defaultValue - value to return when the property is not set
    
    Returns:
    
    value of the property or the defaultValue
  - set
```
@Deprecated
public void set(String name,
                             Object value)
```
    Deprecated. As of 2013 SP1 release, replaced by setGlobalProperty(K, V)
    
    Sets property value to an object. It uses global TransformContext to set property value.
    
    Parameters:
    
    name - property to retrieve
    
    value - value for the property
  - setBoolean
```
@Deprecated
public void setBoolean(String name,
                                    boolean value)
```
    Deprecated. As of 2013 SP1 release, replaced by setGlobalProperty(K, V)
    
    Sets property value to a boolean. It uses global TransformContext to set property value.
    
    Parameters:
    
    name - property to retrieve
    
    value - value for the property
  - getBoolean
```
@Deprecated
public boolean getBoolean(String name,
                                       boolean defaultValue)
```
    Deprecated. As of 2013 SP1 release, replaced by getProperty(K, V)
    
    Returns a property as a boolean. If the property is not set, the defaultValue is returned
    
    Parameters:
    
    name - property to retrieve
    
    defaultValue - value to return when the property is not set
    
    Returns:
    
    value of the property or the defaultValue
  - get
```
@Deprecated
public Object get(String name,
                               Object defaultValue)
```
    Deprecated. As of 2013 SP1 release, replaced by getProperty(K, V)
    
    Returns a property as an Object. If the property is not set, the defaultValue is returned
    
    Parameters:
    
    name - property to retrieve
    
    defaultValue - value to return when the property is not set
    
    Returns:
    
    value of the property or the defaultValue
  - getString
```
@Deprecated
public String getString(String name,
                                     String defaultValue)
```
    Deprecated. As of 2013 SP1 release, replaced by getProperty(K, V)
    
    Returns a property as a String. If the property is not set, the defaultValue is returned
    
    Parameters:
    
    name - property to retrieve
    
    defaultValue - value to return when the property is not set
    
    Returns:
    
    value of the property or the defaultValue

Class TransformContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARAM_USER

PARAM_TAG_POSTPROCESSORS

PARAM_WEB_CONTEXT

Constructor Detail

TransformContext

TransformContext

Method Detail

getGlobalExecutionArguments

setGlobalExecutionArguments

nullContext

getEnclosingContext

getRenderParameters

getCodeBlockStartMarker

getCodeBlockEndMarker

setTagBodyIsCodeBlock

isTagBodyCodeBlock

getItemURI

setItemURI

getPublicationId

getPublicationURI

contains

remove

getProperty

setGlobalProperty

setProperty

isRootContext

getGlobalContext

setString

setInt

getInt

set

setBoolean

getBoolean

get

getString