Package com.aquima.interactions.portal.ds.xml.parsing

Class ComposerDS

java.lang.Object

com.aquima.interactions.portal.ds.xml.parsing.ComposerDS

All Implemented Interfaces:

IComposerDS, IReportingDS

public final class ComposerDS
extends Object
implements IComposerDS

Internal wrapper class to add inline justifaction texts to the composer.

Since:

8.3

Author:

Jon van Leuven

Field Summary

Fields inherited from interface com.aquima.interactions.composer.ds.IComposerDS

CATEGORY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ComposerDS(IComposerDS delegate, XmlJustificationAsset[] assets)

Method Summary

Modifier and Type	Method	Description
void	addMessage(ErrorCode code, String[] parameters, Severity severity)	This method will add an initialization error to the report for the specified error code and parameters.
void	iterateContent(IContentVisitor visitor)	This method should iterate over all the elements that need to be available in the composer, and add them to the provided visitor.
void	iterateStyles(IContentStyleVisitor visitor)	This method should iterate over all the styles that may be used in documents, and add them to the supplied visitor.

Methods inherited from class java.lang.Object

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

Constructor Details

ComposerDS

protected ComposerDS(IComposerDS delegate,
 XmlJustificationAsset[] assets)

Method Details

iterateContent

public void iterateContent(IContentVisitor visitor)
                    throws InitializationException

Description copied from interface: IComposerDS

This method should iterate over all the elements that need to be available in the composer, and add them to the provided visitor.

Specified by:

iterateContent in interface IComposerDS

Parameters:

visitor - The visitor that should be used to add the elements to.

Throws:

InitializationException - This exception is thrown when the elements could not be added.

iterateStyles

public void iterateStyles(IContentStyleVisitor visitor)
                   throws InitializationException

Description copied from interface: IComposerDS

This method should iterate over all the styles that may be used in documents, and add them to the supplied visitor.

Note: This method should be invoked before the iterateContent method, as the content depends on style definitions being present.

Specified by:

iterateStyles in interface IComposerDS

Parameters:

visitor - The visitor that should be used to add the style definitions to.

Throws:

InitializationException - This exception is thrown when the style definitions could not be initialized due to a fatal error.

addMessage

public void addMessage(ErrorCode code,
 String[] parameters,
 Severity severity)

Description copied from interface: IReportingDS

This method will add an initialization error to the report for the specified error code and parameters.

Specified by:

addMessage in interface IReportingDS

Parameters:

code - Error code identifying the message.

parameters - Optional array of parameters for the message.

severity - The severity of the message.