com.tridion.tcdl

Class TagHandlerRegistry

java.lang.Object

com.tridion.tcdl.TagHandlerRegistry

All Implemented Interfaces:

com.tridion.configuration.Configurable

public class TagHandlerRegistry
extends Object
implements com.tridion.configuration.Configurable

Registry of and producer of TagHandler classes for tags. Each tag consists of a namespace and a name. Each tag may be handled by a chain of TagHandlers. This registry provides access to the configuration of these tags and produces a list (chain) of TagHandlers for a given tag.

Constructor Summary

Constructors

Constructor and Description
TagHandlerRegistry() Constructs an empty TagHandlerRegistry.
TagHandlerRegistry(boolean registerInternal) Constructs the TagHandlerRegistry, when [registerInternal] is true it will register all tcdl internal tag handlers for Tridion.
TagHandlerRegistry(boolean registerInternal, TCDLMode mode) Constructs the TagHandlerRegistry, when [registerInternal] is true it will register all tcdl internal tag handlers for Tridion.
TagHandlerRegistry(TCDLMode mode, DefaultTagSet tagSet) Constructs the TagHandlerRegistry, when [registerInternal] is true it will register all tcdl internal tag handlers using [tagSet] for specific service.

Method Summary

Modifier and Type	Method and Description
void	configure(com.tridion.configuration.Configuration configuration) Allows for the registration of tags and their handlers using a Tridion configuration file Note that calling this method will cause registration entries to be added to any existing entries.
Collection<String>	getNamespaceList() Returns the unique set of namespace identifiers currently present in the registry.
Collection<TagMetaEventListener>	getTagMetaEventListeners()
boolean	hasHandlerForTag(Tag tag) Returns true if the registry has at least one TagHandler for the tag.
boolean	hasIterationSupportForTag(Tag tag) Returns true if the registry has at least one TagHandler for the tag that provides IterationTag support.
Collection<TagHandlerBase>	newHandlerChain(Tag tag) Returns a Collection of TagHandlers (e.g.
void	registerHandler(String tagNamespace, String tagName, String className, boolean mayGenerateCodeBlock) Same as registerHandler(String, String, String, String, boolean), but without explicit content namespace.
void	registerHandler(String tagNamespace, String tagName, String className, String namespace, boolean mayGenerateCodeBlock) Registers a TagHandler by its class name for the given namespace and tag name.
Object	unwrap(Object container) Unwraps an object if the registry knows the wrapper type.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagHandlerRegistry

public TagHandlerRegistry()

Constructs an empty TagHandlerRegistry.

TagHandlerRegistry

public TagHandlerRegistry(boolean registerInternal)
                   throws TCDLTransformerException

Constructs the TagHandlerRegistry, when [registerInternal] is true it will register all tcdl internal tag handlers for Tridion. This is used as a default situation in the deployer TCDL transformation process to prevent unnecessary configuration for most users.

Parameters:

registerInternal - when true all internal tag handlers are setup correctly

Throws:

TCDLTransformerException - if any trouble during registering occurs

TCDLTransformerException

TagHandlerRegistry

public TagHandlerRegistry(boolean registerInternal,
                          TCDLMode mode)
                   throws TCDLTransformerException

Constructs the TagHandlerRegistry, when [registerInternal] is true it will register all tcdl internal tag handlers for Tridion. This is used as a default situation in the deployer TCDL transformation process to prevent unnecessary configuration for most users.

Parameters:

registerInternal - when true all internal tag handlers are setup correctly.

mode - The mode for the internal TCDL handlers to register (i.e. TRANSFORMATION or RENDER).

Throws:

TCDLTransformerException - if any trouble during registering occurs.

TCDLTransformerException

TagHandlerRegistry

public TagHandlerRegistry(TCDLMode mode,
                          DefaultTagSet tagSet)
                   throws TCDLTransformerException

Constructs the TagHandlerRegistry, when [registerInternal] is true it will register all tcdl internal tag handlers using [tagSet] for specific service. This is used as a default situation in the deployer TCDL transformation process to prevent unnecessary configuration for most users.

Parameters:

mode - The mode for the internal TCDL handlers to register (i.e. TRANSFORMATION or RENDER).

tagSet - The default tags handlers to register (i.e. TCM or ISH).

Throws:

TCDLTransformerException - if any trouble during registering occurs.

TCDLTransformerException

Method Detail

newHandlerChain

public Collection<TagHandlerBase> newHandlerChain(Tag tag)
                                           throws TCDLTransformerException

Returns a Collection of TagHandlers (e.g. the handler chain) for the given Tag [tag]. Each TagHandler in the returned collection is always a newly created instance

Parameters:

tag - Tag for which the TagHandlers must.

Returns:

a collection of TagHandlers.

Throws:

TCDLTransformerException - If a TagHandler class could not be created.

TCDLTransformerException

hasIterationSupportForTag

public boolean hasIterationSupportForTag(Tag tag)
                                  throws TCDLTransformerException

Returns true if the registry has at least one TagHandler for the tag that provides IterationTag support.

Parameters:

tag - the tag to check for a TagHandler.

Returns:

true if the registry has at least one IterationSupport TagHandler for the tag.

Throws:

TCDLTransformerException

hasHandlerForTag

public boolean hasHandlerForTag(Tag tag)

Returns true if the registry has at least one TagHandler for the tag.

Parameters:

tag - the tag to check for a TagHandler.

Returns:

true if the registry has at least one TagHandler for the tag.

unwrap

public Object unwrap(Object container)

Unwraps an object if the registry knows the wrapper type.

Parameters:

container - object to unwrap

Returns:

the unwrapped object or the passed object if the wrapper type is unknown

registerHandler

public void registerHandler(String tagNamespace,
                            String tagName,
                            String className,
                            String namespace,
                            boolean mayGenerateCodeBlock)
                     throws TCDLTransformerException

Registers a TagHandler by its class name for the given namespace and tag name. If a TagHandler was already registered, the TagHandler is added to that chain. Duplicate TagHandlers in the same chain are not allowed. Tag configured for IterationTagSupport can not have multiple implementation classes.

Parameters:

tagNamespace - Namespace in which the Tag lives

tagName - name of the Tag the TagHandler should be associated with

className - Name of the TagHandler class

namespace - Content namespace (e.g., "ish" or "tcm")

mayGenerateCodeBlock - if the body result of this TagHandler may be wrapped in a code block (although the handler has the final say in this)

Throws:

TCDLTransformerException - If the registration could not be completed. Most likely due to duplicate registration of a TagHandler for the same Tag.

TCDLTransformerException

registerHandler

public void registerHandler(String tagNamespace,
                            String tagName,
                            String className,
                            boolean mayGenerateCodeBlock)
                     throws TCDLTransformerException

Same as registerHandler(String, String, String, String, boolean), but without explicit content namespace.

Throws:

TCDLTransformerException

getTagMetaEventListeners

public Collection<TagMetaEventListener> getTagMetaEventListeners()

getNamespaceList

public Collection<String> getNamespaceList()

Returns the unique set of namespace identifiers currently present in the registry.

Returns:

unique set of namespace identifiers currently present in the registry

configure

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

Allows for the registration of tags and their handlers using a Tridion configuration file Note that calling this method will cause registration entries to be added to any existing entries.

Specified by:

configure in interface com.tridion.configuration.Configurable

Parameters:

configuration - containing the tag configuration to add to this registry

Throws:

com.tridion.configuration.ConfigurationException