Package com.aquima.interactions.framework.documents

Class DefaultRendererFactory

java.lang.Object

com.aquima.interactions.framework.documents.DefaultRendererFactory

All Implemented Interfaces:

IRendererFactory

public class DefaultRendererFactory
extends Object
implements IRendererFactory

Renderer factory implementation that provides the default supported document renderer (IBex).

This default renderer uses the XmlDocumentRenderer as default xml renderer. Use the setXmlRenderer method to override the xml renderer.

Since:

6.0

Author:

Jon van Leuven, O. Kerpershoek

See Also:

The default renderer that is used.

Constructor Summary

Constructors

Constructor	Description
DefaultRendererFactory()
DefaultRendererFactory(IDocumentsProperties documentsProperties)

Method Summary

Modifier and Type	Method	Description
protected String	getDocumentsBaseFolder()
OutputFormat[]	getOutputFormats()	This method returns the output formats that are supported by the renderer factory.
IDocumentRenderer	getRenderer(IResourceManager manager, String documentName, OutputFormat[] formats)	Gets the renderer for the document
void	setConfig(String config)	Set the config resource.
protected void	setDocumentsBaseFolder(IDocumentsProperties documentsProperties)
void	setStylesheet(String stylesheet)	Set the stylesheet resource.
void	setXmlRenderer(IXmlRenderer xmlRenderer)	Set the xmlRenderer.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRendererFactory

public DefaultRendererFactory()

DefaultRendererFactory

public DefaultRendererFactory(IDocumentsProperties documentsProperties)

Method Detail

setDocumentsBaseFolder

protected void setDocumentsBaseFolder(IDocumentsProperties documentsProperties)

getDocumentsBaseFolder

protected String getDocumentsBaseFolder()

getOutputFormats

public OutputFormat[] getOutputFormats()

Description copied from interface: IRendererFactory

This method returns the output formats that are supported by the renderer factory.

Specified by:

getOutputFormats in interface IRendererFactory

Returns:

Array containing the output formats that are supported by the renderer factory.

getRenderer

public IDocumentRenderer getRenderer(IResourceManager manager,
                                     String documentName,
                                     OutputFormat[] formats)
                              throws UnsupportedOutputFormatException

Gets the renderer for the document

Specified by:

getRenderer in interface IRendererFactory

Parameters:

manager - The resource manager to use, may be null

documentName - name of the document, may be null

formats - the outputformat(s) to render to, can not be null

Returns:

this.renderer the document renderer

Throws:

UnsupportedOutputFormatException - This exception is thrown when no renderer is available for the requested output format.

setStylesheet

public void setStylesheet(String stylesheet)

Set the stylesheet resource. The default resource is documents/ibex/styles.xsl

Parameters:

stylesheet - The style sheet resource.

setConfig

public void setConfig(String config)

Set the config resource. The default resource is documents/ibex/ibex-config.xml

Parameters:

config - The config sheet resource.

setXmlRenderer

public void setXmlRenderer(IXmlRenderer xmlRenderer)

Set the xmlRenderer.

Parameters:

xmlRenderer - The document xml renderer to be used for document rendering.