Package com.aquima.interactions.spellengine.ds

Interface ISpellerDS

All Known Implementing Classes:
XmlSpellerDS
public interface ISpellerDS
This data source is used to initialize a speller.
Since:
6.0
Author:
Jon van Leuven

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    This method returns the optional description of the speller.
    String
    getName()
    This method returns the name of the speller.
    String
    getNegativeRule()
    This method returns the optional rule for negative integers.
    IRangeValue
    getRange()
    This method returns the optional range for which this speller is valid.
    void
    iterateMacros(IMacroVisitor visitor)
    This method should iterate over the macros and call the visitor for every macro.
    void
    iterateRules(IRuleVisitor visitor)
    This method should iterate over the rules and call the visitor for every rule.

  • Method Details

    • getName

      String getName()
      This method returns the name of the speller.
      Returns:
      Name of the speller (never null)

    • getDescription

      String getDescription()
      This method returns the optional description of the speller.
      Returns:
      Description of the speller (may be null)

    • getNegativeRule

      String getNegativeRule()
      This method returns the optional rule for negative integers.
      Returns:
      The rule (may be null)

    • iterateRules

      void iterateRules(IRuleVisitor visitor)
      This method should iterate over the rules and call the visitor for every rule.
      Parameters:
      visitor - The visitor to use for every rule.

    • iterateMacros

      void iterateMacros(IMacroVisitor visitor)
      This method should iterate over the macros and call the visitor for every macro.
      Parameters:
      visitor - The visitor to use for every macro.

    • getRange

      IRangeValue getRange()
      This method returns the optional range for which this speller is valid. If this method returns null, no there is no restriction to the integer that can be spelled.
      Returns:
      The range (may be null)