Package com.aquima.interactions.framework.renderer.document

Class DocumentXmlRenderer

java.lang.Object

com.aquima.interactions.framework.renderer.XmlRendererBase

com.aquima.interactions.framework.renderer.document.DocumentXmlRenderer

All Implemented Interfaces:

IXmlRenderer

public final class DocumentXmlRenderer
extends XmlRendererBase

Default xml renderer to render composer objects to document xml.

Since:

7.0

Author:

Jon van Leuven

Constructor Summary

Constructors

Constructor	Description
DocumentXmlRenderer(Map<String,IXmlElementRenderer> customRenderers)	Constructs the XmlDocumentRenderer without any default renderers.

Method Summary

Modifier and Type	Method	Description
static DocumentXmlRenderer	createFor(Map<String,IXmlElementRenderer> customRenderers, boolean tagsUppercase, boolean sortDomainValues, String rendererName)	Constructs the renderer with the default renderers, and a map containing custom element renderers.
protected IXmlPostProcessor	getPostProcessor()
protected IXmlRendererContext	getRendererContext(ApplicationID applicationId, ILanguage language, ILanguage defaultLanguage, IParameters parameters, IRuntimeKeyPrinter printer)

Methods inherited from class com.aquima.interactions.framework.renderer.XmlRendererBase

generateXml, generateXml, getConverters, getDefaultElementRenderer, setDefaultElementRenderer

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentXmlRenderer

public DocumentXmlRenderer(Map<String,IXmlElementRenderer> customRenderers)

Constructs the XmlDocumentRenderer without any default renderers.

Parameters:

customRenderers - Map containing renderers for custom elements.

Method Details

createFor

public static DocumentXmlRenderer createFor(Map<String,IXmlElementRenderer> customRenderers,
 boolean tagsUppercase,
 boolean sortDomainValues,
 String rendererName)

Constructs the renderer with the default renderers, and a map containing custom element renderers.

Note that the created renderer will not fail (throw an exception) when there is no renderer available for an element, for unknown elements the XmlUnknownElement renderer will be used.

Parameters:

customRenderers - Map containing renderers for custom elements.

tagsUppercase - If true all tags are converted to uppercase, otherwise no conversion for the tag names.

sortDomainValues - Boolean to enable/disable sorting by short value of domain values in the resulting xml.

rendererName - Optional renderer name.

Returns:

XmlRenderer containing the custom renderers and the default document renderers.

See Also:

• XmlAsset
• XmlButton
• XmlContainer
• XmlContentItem
• XmlDocument
• XmlField
• XmlIgnoreElement
• XmlImage
• XmlPage
• XmlTextItem
• XmlUnknownElement

getPostProcessor

protected IXmlPostProcessor getPostProcessor()

Specified by:

getPostProcessor in class XmlRendererBase

getRendererContext

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

Specified by:

getRendererContext in class XmlRendererBase