org.puimula.libvoikko

Class Voikko

java.lang.Object

org.puimula.libvoikko.Voikko

public class Voikko
extends Object

Represents an instance of Voikko. The instance has state, such as settings related to spell checking and hyphenation, and methods for performing various natural language analysis operations. Methods in this class are synchronized so that, unlike the underlying C library, these objects can be safely used from multiple threads. Heavily multithreaded applications should still create separate instances for each thread for better performance.

Constructor Summary

Constructors

Constructor and Description
Voikko(String language) Creates a new Voikko instance using only the default dictionary search path
Voikko(String language, String path) Creates a new Voikko instance

Method Summary

Methods

Modifier and Type	Method and Description
static void	addLibraryPath(String libraryPath) Set the explicit path to the folder containing shared library files.
List<Analysis>	analyze(String word) Analyze the morphology of given word and return the list of analysis results.
protected void	finalize()
String	getHyphenationPattern(String word) Return a character pattern that describes the hyphenation of given word
String	grammarErrorExplanation(int errorCode, String language)
List<GrammarError>	grammarErrors(String text) Check the given text for grammar errors and return a list of GrammarError objects representing the errors that were found.
String	hyphenate(String word)
static List<Dictionary>	listDicts()
static List<Dictionary>	listDicts(String path)
List<Sentence>	sentences(String text) Split the given natural language text into a list of Sentence objects.
void	setAcceptAllUppercase(boolean value) Accept words even when all of the letters are in uppercase.
void	setAcceptBulletedListsInGc(boolean value) (Grammar checking only): Accept paragraphs if they would be valid within bulleted lists.
void	setAcceptExtraHyphens(boolean value) (Spell checking only): Allow some extra hyphens in words.
void	setAcceptFirstUppercase(boolean value) Accept words even when the first letter is in uppercase (start of sentence etc.)
void	setAcceptMissingHyphens(boolean value) (Spell checking only): Accept missing hyphens at the start and end of the word.
void	setAcceptTitlesInGc(boolean value) (Grammar checking only): Accept incomplete sentences that could occur in titles or headings.
void	setAcceptUnfinishedParagraphsInGc(boolean value) (Grammar checking only): Accept incomplete sentences at the end of the paragraph.
void	setHyphenateUnknownWords(boolean value) (Hyphenation only): Hyphenate unknown words.
void	setIgnoreDot(boolean value) Ignore dot at the end of the word (needed for use in some word processors).
void	setIgnoreNonwords(boolean value) (Spell checking only): Ignore non-words such as URLs and email addresses.
void	setIgnoreNumbers(boolean value) Ignore words containing numbers.
void	setIgnoreUppercase(boolean value) Accept words that are written completely in uppercase letters without checking them at all.
void	setMinHyphenatedWordLength(int length) The minimum length for words that may be hyphenated.
void	setNoUglyHyphenation(boolean value) Do not insert hyphenation positions that are considered to be ugly but correct Default: false
void	setSpellerCacheSize(int sizeParam) Controls the size of in memory cache for spell checking results. 0 is the default size, 1 is twice as large as 0 etc. -1 disables the spell checking cache entirely.
void	setSuggestionStrategy(SuggestionStrategy suggestionStrategy) Set the suggestion strategy to be used when generating spelling suggestions.
boolean	spell(String word) Check the spelling of given word.
List<String>	suggest(String word)
void	terminate() Releases the resources allocated by libvoikko for this instance.
List<Token>	tokens(String text) Split the given natural language text into a list of Token objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

Voikko

public Voikko(String language)

Creates a new Voikko instance using only the default dictionary search path

Parameters:

language - BCP 47 language tag to be used

Voikko

public Voikko(String language,
      String path)

Creates a new Voikko instance

Parameters:

language - BCP 47 language tag to be used

path - Extra path that will be checked first when looking for linguistic resources

Method Detail

terminate

public void terminate()

Releases the resources allocated by libvoikko for this instance. The instance cannot be used anymore after this method has been called. The resources are released automatically when the object is finalized. This method may be used to make sure that the resources are immediately released since they may take significant amount of memory.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

spell

public boolean spell(String word)

Check the spelling of given word.

Parameters:

word -

Returns:

true if the word is correct, false if it is incorrect.

listDicts

public static List<Dictionary> listDicts()

Returns:

a list of Dictionary objects representing the available dictionary variants within standard search path.

listDicts

public static List<Dictionary> listDicts(String path)

Parameters:

path -

Returns:

a list of Dictionary objects representing the available dictionary variants within given directory and standard search path.

suggest

public List<String> suggest(String word)

Parameters:

word -

Returns:

a list of suggested spellings for given (misspelled) word. If the given word is correct, the list contains only the word itself

grammarErrors

public List<GrammarError> grammarErrors(String text)

Check the given text for grammar errors and return a list of GrammarError objects representing the errors that were found. Unlike the C based API this method accepts multiple paragraphs separated by newline characters.

Parameters:

text -

Returns:

list of grammar errors

grammarErrorExplanation

public String grammarErrorExplanation(int errorCode,
                             String language)

Parameters:

errorCode - grammar error code

language - language in which the explanation should be returned

Returns:

a human readable explanation for grammar error

analyze

public List<Analysis> analyze(String word)

Analyze the morphology of given word and return the list of analysis results.

Parameters:

word -

Returns:

analysis results

tokens

public List<Token> tokens(String text)

Split the given natural language text into a list of Token objects.

Parameters:

text -

Returns:

list of tokens

sentences

public List<Sentence> sentences(String text)

Split the given natural language text into a list of Sentence objects.

Parameters:

text -

Returns:

list of sentences

getHyphenationPattern

public String getHyphenationPattern(String word)

Return a character pattern that describes the hyphenation of given word. ' ' = no hyphenation at this character, '-' = hyphenation point (character at this position is preserved in the hyphenated form), '=' = hyphentation point (character at this position is replaced by the hyphen.)

Parameters:

word -

Returns:

hyphenation pattern

hyphenate

public String hyphenate(String word)

Parameters:

word -

Returns:

the given word in fully hyphenated form.

setIgnoreDot

public void setIgnoreDot(boolean value)

Ignore dot at the end of the word (needed for use in some word processors). If this option is set and input word ends with a dot, spell checking and hyphenation functions try to analyze the word without the dot if no results can be obtained for the original form. Also with this option, string tokenizer will consider trailing dot of a word to be a part of that word. Default: false

Parameters:

value -

setIgnoreNumbers

public void setIgnoreNumbers(boolean value)

Ignore words containing numbers. Default: false

Parameters:

value -

setIgnoreUppercase

public void setIgnoreUppercase(boolean value)

Accept words that are written completely in uppercase letters without checking them at all. Default: false

Parameters:

value -

setAcceptFirstUppercase

public void setAcceptFirstUppercase(boolean value)

Accept words even when the first letter is in uppercase (start of sentence etc.) Default: true

Parameters:

value -

setAcceptAllUppercase

public void setAcceptAllUppercase(boolean value)

Accept words even when all of the letters are in uppercase. Note that this is not the same as setIgnoreUppercase: with this option the word is still checked, only case differences are ignored. Default: true

Parameters:

value -

setIgnoreNonwords

public void setIgnoreNonwords(boolean value)

(Spell checking only): Ignore non-words such as URLs and email addresses. Default: true

Parameters:

value -

setAcceptExtraHyphens

public void setAcceptExtraHyphens(boolean value)

(Spell checking only): Allow some extra hyphens in words. This option relaxes hyphen checking rules to work around some unresolved issues in the underlying morphology, but it may cause some incorrect words to be accepted. The exact behaviour (if any) of this option is not specified. Default: false

Parameters:

value -

setAcceptMissingHyphens

public void setAcceptMissingHyphens(boolean value)

(Spell checking only): Accept missing hyphens at the start and end of the word. Some application programs do not consider hyphens to be word characters. This is reasonable assumption for many languages but not for Finnish. If the application cannot be fixed to use proper tokenization algorithm for Finnish, this option may be used to tell libvoikko to work around this defect. Default: false

Parameters:

value -

setAcceptTitlesInGc

public void setAcceptTitlesInGc(boolean value)

(Grammar checking only): Accept incomplete sentences that could occur in titles or headings. Set this option to true if your application is not able to differentiate titles from normal text paragraphs, or if you know that you are checking title text. Default: false

Parameters:

value -

setAcceptUnfinishedParagraphsInGc

public void setAcceptUnfinishedParagraphsInGc(boolean value)

(Grammar checking only): Accept incomplete sentences at the end of the paragraph. These may exist when text is still being written. Default: false

Parameters:

value -

setAcceptBulletedListsInGc

public void setAcceptBulletedListsInGc(boolean value)

(Grammar checking only): Accept paragraphs if they would be valid within bulleted lists. Default: false

Parameters:

value -

setNoUglyHyphenation

public void setNoUglyHyphenation(boolean value)

Do not insert hyphenation positions that are considered to be ugly but correct Default: false

Parameters:

value -

setHyphenateUnknownWords

public void setHyphenateUnknownWords(boolean value)

(Hyphenation only): Hyphenate unknown words. Default: true

Parameters:

value -

setMinHyphenatedWordLength

public void setMinHyphenatedWordLength(int length)

The minimum length for words that may be hyphenated. This limit is also enforced on individual parts of compound words. Default: 2

Parameters:

length -

setSpellerCacheSize

public void setSpellerCacheSize(int sizeParam)

Controls the size of in memory cache for spell checking results. 0 is the default size, 1 is twice as large as 0 etc. -1 disables the spell checking cache entirely.

Parameters:

sizeParam -

setSuggestionStrategy

public void setSuggestionStrategy(SuggestionStrategy suggestionStrategy)

Set the suggestion strategy to be used when generating spelling suggestions. Default: SuggestionStrategy.TYPO

Parameters:

suggestionStrategy -

addLibraryPath

public static void addLibraryPath(String libraryPath)

Set the explicit path to the folder containing shared library files.

Parameters:

libraryPath -