Package com.aquima.interactions.spellengine.model

Class SpellEngine

java.lang.Object

com.aquima.interactions.spellengine.model.SpellEngine

All Implemented Interfaces:

ISpellEngine, Serializable

public class SpellEngine
extends Object
implements ISpellEngine

Spell engine implementation.

Since:

6.0

Author:

Jon van Leuven

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SpellEngine(ISpellEngineDS datasource)	Constructor to create a spell engine based on a datasource.

Method Summary

Modifier and Type	Method	Description
void	addSpeller(SpellerDefinition definition)	This method add a speller to the spell engine.
ISpeller	getSpeller(String spellerName)	This method returns a speller.
String[]	getSpellerNames()	This method returns the names of all available spellers in the spell engine.

Methods inherited from class java.lang.Object

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

Constructor Details

SpellEngine

public SpellEngine(ISpellEngineDS datasource)
            throws InitializationException

Constructor to create a spell engine based on a datasource.

Parameters:

datasource - The data source used for initialization.

Throws:

InitializationException - Is thrown when the speller failed initialization.

Method Details

addSpeller

public void addSpeller(SpellerDefinition definition)

This method add a speller to the spell engine. Should only be used during initialization.

Parameters:

definition - Speller definition to add.

getSpeller

public ISpeller getSpeller(String spellerName)
                    throws UnknownSpellerException

Description copied from interface: ISpellEngine

This method returns a speller.

Specified by:

getSpeller in interface ISpellEngine

Parameters:

spellerName - The speller name used for lookup.

Returns:

Speller The speller

Throws:

UnknownSpellerException - Is thrown when the speller does not exist.

getSpellerNames

public String[] getSpellerNames()

Description copied from interface: ISpellEngine

This method returns the names of all available spellers in the spell engine.

Specified by:

getSpellerNames in interface ISpellEngine

Returns:

The names of the available spellers, never null