Package com.aquima.interactions.framework.renderer

Class XmlRendererBase

java.lang.Object

com.aquima.interactions.framework.renderer.XmlRendererBase

All Implemented Interfaces:

IXmlRenderer

Direct Known Subclasses:

DocumentXmlRenderer, PageR6XmlRenderer

public abstract class XmlRendererBase
extends Object
implements IXmlRenderer

This class is responsible for rendering a page object to an xml view. The actual XML structure can be customised by a plugin. This class is renamed from AbstractXmlRenderer since version 6.4

Since:

6.0

Author:

F. van der Meer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlRendererBase(Map<String,IXmlElementRenderer> customConverters)

Method Summary

Modifier and Type	Method	Description
IXmlElement	generateXml(IElement compositeElement, ApplicationID applicationId, ILanguage language, ILanguage defaultLanguage, IParameters parameters)
IXmlElement	generateXml(IElement compositeElement, ApplicationID applicationId, ILanguage language, ILanguage defaultLanguage, IParameters parameters, IRuntimeKeyPrinter printer)	This method converts the page element to an XML element.
protected Map<String,IElementRenderer>	getConverters()
IXmlElementRenderer	getDefaultElementRenderer()	This method returns the default renderer that will be used as default renderer, when no renderer could be located.
protected abstract IXmlPostProcessor	getPostProcessor()
protected abstract IXmlRendererContext	getRendererContext(ApplicationID applicationId, ILanguage language, ILanguage defaultLanguage, IParameters parameters, IRuntimeKeyPrinter printer)
void	setDefaultElementRenderer(IXmlElementRenderer renderer)	This method sets a renderer that will be used as default renderer, when no renderer could be located.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlRendererBase

protected XmlRendererBase(Map<String,IXmlElementRenderer> customConverters)

Method Detail

getConverters

protected Map<String,IElementRenderer> getConverters()

getPostProcessor

protected abstract IXmlPostProcessor getPostProcessor()

getRendererContext

protected abstract IXmlRendererContext getRendererContext(ApplicationID applicationId,
                                                          ILanguage language,
                                                          ILanguage defaultLanguage,
                                                          IParameters parameters,
                                                          IRuntimeKeyPrinter printer)

generateXml

public IXmlElement generateXml(IElement compositeElement,
                               ApplicationID applicationId,
                               ILanguage language,
                               ILanguage defaultLanguage,
                               IParameters parameters,
                               IRuntimeKeyPrinter printer)
                        throws AppException

This method converts the page element to an XML element.

Specified by:

generateXml in interface IXmlRenderer

Parameters:

compositeElement - The element that should be converted to XML.

applicationId - The ID of the application for which the conversion takes place.

language - The language that should be used when converting multilingual objects.

defaultLanguage - The default language that should be used when no content could be found for the main language.

parameters - Additional parameters for the renderer context.

printer - The optional runtime key printer, may be null.

Returns:

XML element for the page element.

Throws:

AppException - This exception is thrown when the page element could not be converted to XML.

generateXml

public IXmlElement generateXml(IElement compositeElement,
                               ApplicationID applicationId,
                               ILanguage language,
                               ILanguage defaultLanguage,
                               IParameters parameters)
                        throws AppException

Throws:

AppException

getDefaultElementRenderer

public IXmlElementRenderer getDefaultElementRenderer()

This method returns the default renderer that will be used as default renderer, when no renderer could be located.

Returns:

The default renderer, can be null.

setDefaultElementRenderer

public void setDefaultElementRenderer(IXmlElementRenderer renderer)

This method sets a renderer that will be used as default renderer, when no renderer could be located.

Parameters:

renderer - The renderer to use as default renderer.