psdi.webclient.beans.common

Class SpellingSessionAdapter

java.lang.Object

psdi.webclient.beans.common.SpellingSessionAdapter

public class SpellingSessionAdapter
extends java.lang.Object

Spelling Session Adapter. Used during Spell Check on long description dialogs.

Constructor Summary

Constructors

Constructor and Description
SpellingSessionAdapter(WebClientSession wcs, java.lang.String spellString)

Method Summary

Modifier and Type	Method and Description
com.wintertree.ssce.Lexicon[]	getLexicons() Get the Spelling lexicons associated with this Spelling Session object
int	getNumOfWordsReplaced() Returns the number of words replaced in this spelling session
com.wintertree.ssce.SpellingSession	getSpeller() Returns the Spelling session object
java.lang.String	getSpellingError(java.lang.String error) Retrieve the spelling error message for the given key
java.lang.String	getSpellString() Returns the string on which the spell checker is to be run
com.wintertree.ssce.StringWordParser	getWordParser() Returns the String Word Parser associated with this Spelling Session object
void	init() Initialize this SpellingSessionAdapter.
void	setNumOfWordsReplaced(int numOfWordsReplaced) Set the number of words replaced in this spelling session

Methods inherited from class java.lang.Object

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

Constructor Detail

SpellingSessionAdapter

public SpellingSessionAdapter(WebClientSession wcs,
                              java.lang.String spellString)
                       throws MXException

Throws:

MXException

Method Detail

init

public void init()
          throws MXException

Initialize this SpellingSessionAdapter. Must be called after the constructor. It loads the appropriate Spelling Lexicons based on the user's language code and constructs the Spelling Session and String Word Parser objects. Attaches this SpellingSessionAdapter object to the WebClientSession.

Throws:

MXException - Maximo Exception

getLexicons

public com.wintertree.ssce.Lexicon[] getLexicons()

Get the Spelling lexicons associated with this Spelling Session object

Returns:

Returns the lexicons.

getSpeller

public com.wintertree.ssce.SpellingSession getSpeller()

Returns the Spelling session object

Returns:

Returns the Spelling session object

getSpellString

public java.lang.String getSpellString()

Returns the string on which the spell checker is to be run

Returns:

Returns the spellString

getWordParser

public com.wintertree.ssce.StringWordParser getWordParser()

Returns the String Word Parser associated with this Spelling Session object

Returns:

Returns the StringWordParser

getNumOfWordsReplaced

public int getNumOfWordsReplaced()

Returns the number of words replaced in this spelling session

Returns:

Returns the numOfWordsReplaced.

setNumOfWordsReplaced

public void setNumOfWordsReplaced(int numOfWordsReplaced)

Set the number of words replaced in this spelling session

Parameters:

numOfWordsReplaced - number of words replaced in this spelling session

getSpellingError

public java.lang.String getSpellingError(java.lang.String error)

Retrieve the spelling error message for the given key

Parameters:

error - error key

Returns:

spelling error message