Package com.aquima.interactions.composer.ds

Interface ITextNodeDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
XmlTextNodeDS, XmlTextNodeDS
public interface ITextNodeDS extends IReportingDS
This interface is used to initialize a text node of a text element.
Since:
6.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMaskCallName()
    This method returns the mask call for this node.
    TextNodeType
    getType()
    This method returns the type of the text node.
    String
    getValue()
    This method returns the value of the text node.
    void
    iterateChildNodes(ITextNodeVisitor visitor)
    This method should iterate over all the child nodes of the current text node, and add them to the provided visitor.

    Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

    addMessage

  • Method Details

    • getType

      TextNodeType getType()
      This method returns the type of the text node.
      Returns:
      the type of the text node.

    • getValue

      String getValue()
      This method returns the value of the text node. Depending on the type of the text node, the value will be interpreted differently.

      The value has the following meaning for the different types:

      • ROOT - Value is ignored
      • CONDITION - The value contains the expression that should be evaluated.
      • TEXT - The value contains the text that should be displayed.
      • FIELD - The value contains the expression whose value should be shown.
      • STYLE - The value contains the presentation style that should be used (bold, italic, etc...).
      Returns:
      The value for the text node.

    • iterateChildNodes

      void iterateChildNodes(ITextNodeVisitor visitor)
      This method should iterate over all the child nodes of the current text node, and add them to the provided visitor. The iterateChildNodes method will only be invoked for nodes that can actually have children.
      Parameters:
      visitor - The visitor that should be used to add the child nodes to.
      Throws:
      InitializationException - This exception is thrown when the definition could not be initialized due to a fatal error.

    • getMaskCallName

      String getMaskCallName()
      This method returns the mask call for this node. Only applicable to field nodes. This method can return null.
      Returns:
      The mask call name for this node.