Technical details

• Packaging: Java^TM class library compatible with JDK 1.x and Java 2 (J2SE and J2EE).
  
• Performance: Checks spelling at over 20,000 words per second on modest hardware.
  
• Class library size: 72K.
  
• Dictionary file size: Average of .5Mb per language.
  
• Run-time memory requirements: Typically 1 - 2 Mb.
  
• Platforms supported: Any JVM-compliant platform.

The Spellex SDK for Java^TM Technology Spell Checker engine's API provides direct, straightforward calling from Java applications, applets, and servlets.

Spellex's application program interface consists of various Java classes:

Class SpellingSession: Performs general-purpose spell checking of words and strings. Major methods include:

check
Check the spelling of a word or string

getLexicons, setLexicons
Get/set the set of lexicons (dictionaries) used to check spelling. The set of lexicons is represented as an Array.

getOption, setOption
Get/set option values:

• CASE_SENSITIVE_OPT: Enable if words with different letter-case patterns should be treated as different words.
  
• IGNORE_ALL_CAPS_WORD_OPT: Enable if checked words consisting entirely of upper-case letters should be ignored.
  
• IGNORE_CAPPED_WORD_OPT: Enable if checked words should be ignored if they begin with an upper-case letter.
  
• IGNORE_DOMAIN_NAMES_OPT: Enable to ignore (skip) words that appear to be Internet domain names.
  
• IGNORE_MIXED_CASE_OPT: Enable if checked words containing an unusual mixture of upper- and lower-case letters should be ignored.
  
• IGNORE_MIXED_DIGITS_OPT: Enable if checked words containing a mixture of letters and digits or other symbols should be ignored.
  
• REPORT_DOUBLED_WORD_OPT: Enable if two occurrences of the same word in a row should be reported.
  
• REPORT_MIXED_CASE_OPT: Enable if checked words containing an unusual combination of upper- and lower-case letters should be reported.
  
• REPORT_MIXED_DIGITS_OPT: Enable if checked words containing a combination of letters and digits or other symbols should be reported.
  
• REPORT_UNCAPPED_OPT: Enable if check words should be reported whose first character is not capitalized.
  
• SPLIT_CONTRACTED_WORDS_OPT: Enable if apostrophes should if necessary be as word separators, and each sub-word spell checked individually.
  
• SPLIT_HYPHENATED_WORDS_OPT: Enable if hyphens ("-") as should if necessary be treated as word separators, and each sub-word spell checked individually.
  
• SPLIT_WORDS_OPT: Enable if words should if necessary be treated as a series of concatenated sub-words, and each sub-word spell checked individually.
  
• STRIP_POSSESSIVES_OPT: Enable if possessives of the form xxx's and xxxs' should be removed from words before checking their spelling.
  
• SUGGEST_SPLIT_WORDS_OPT: Enable if suggest() should attempt to split words into two valid sub-words.

suggest
Locate suggested alternate spellings for a misspelled word.

---

Classes FileTextLexicon, StreamTextLexicon, and MemTextLexicon represent permanent (file or stream based) or temporary (memory based) lexicons (dictionaries). Major methods include:

addWord
Add a word to the lexicon.

deleteWord
Remove a word from the lexicon.

words
Enumerate the words in the lexicon.

---

Classes StringWordParser and HTMLStringWordParser are used to access and edit the words contained in a String. HTMLStringWordParser is used to spell check HTML, skipping over the markups and checking just the text. Major methods include:

deleteText
Delete a specified number of characters from the text starting at the current cursor position.

deleteWord
Delete the word at the cursor position.

getCursor
Obtain the current cursor position, expressed as an offset from the start of the text.

getNumReplacements
Get the number of words replaced so far.

getWord
Obtain the word at the WordParser's current cursor position.

insertText
Insert text at a specified position.

isDoubledWord
Determine if the current word and the previous word are identical, and that no punctuation appears between them.

nextWord
Obtain the current word and advance to the next word.

replaceWord
Replace the word at the current position with a new word.

setCursor
Set the cursor to a given position.

toString
Convert the text to String form.