Package com.swabunga.spell.engine
Class Configuration
java.lang.Object
com.swabunga.spell.engine.Configuration
- Direct Known Subclasses:
PropertyConfiguration
The various settings used to control how a spell checker works are read from here.
Includes the COST_* constants that decide how to figure the cost of converting one word to
another in the EditDistance class.
Also includes SPELL_* constants that control how misspellings are detected, for example, how to handle
mixed-case words, etc.
- Author:
- aim4min
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
used by EditDistance: the cost of having to change case, for example, from i to I.static final String
used by EditDistance: the cost of having to insert a character
(integer greater than 0)static final String
used by EditDistance: the cost of having to remove a character
(integer greater than 0)static final String
used by EditDistance: the cost of having to substitute one character for another for the sub value to ever be used, it should be smaller than the COST_REMOVE_CHAR or COST_INSERT_CHAR values
(integer greater than 0)static final String
used by EditDistance: the cost of having to swap two adjoining characters for the swap value to ever be used, it should be smaller than the COST_REMOVE_CHAR or COST_INSERT_CHAR values
(integer greater than 0)static final String
words that have digits in them are not spell checked, example: "mach5"
(boolean)static final String
words that look like an Internet address are not spell checked, example: "http://www.google.com"
(boolean)static final String
words that have mixed case are not spell checked, example: "SpellChecker"
(boolean)static final String
I don't know what this does.static final String
the first word of a sentence is expected to start with an upper case letter
(boolean)static final String
words that are all upper case are not spell checked, example: "CIA"
(boolean)static final String
the maximum cost of suggested spelling. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
getBoolean
(String key) Gets one of the boolean constantsstatic final Configuration
gets a new default Configurationstatic final Configuration
getConfiguration
(String className) Returns a new instance of a Configuration classabstract int
getInteger
(String key) Gets one of the integer constantsabstract void
setBoolean
(String key, boolean value) Sets one of the boolean constantsabstract void
setInteger
(String key, int value) Sets one of the integer constants
-
Field Details
-
COST_REMOVE_CHAR
used by EditDistance: the cost of having to remove a character
(integer greater than 0)- See Also:
-
COST_INSERT_CHAR
used by EditDistance: the cost of having to insert a character
(integer greater than 0)- See Also:
-
COST_SWAP_CHARS
used by EditDistance: the cost of having to swap two adjoining characters for the swap value to ever be used, it should be smaller than the COST_REMOVE_CHAR or COST_INSERT_CHAR values
(integer greater than 0)- See Also:
-
COST_CHANGE_CASE
used by EditDistance: the cost of having to change case, for example, from i to I.
(integer greater than 0)- See Also:
-
COST_SUBST_CHARS
used by EditDistance: the cost of having to substitute one character for another for the sub value to ever be used, it should be smaller than the COST_REMOVE_CHAR or COST_INSERT_CHAR values
(integer greater than 0)- See Also:
-
SPELL_THRESHOLD
the maximum cost of suggested spelling. Any suggestions that cost more are thrown away
integer greater than 1)- See Also:
-
SPELL_IGNOREUPPERCASE
words that are all upper case are not spell checked, example: "CIA"
(boolean)- See Also:
-
SPELL_IGNOREMIXEDCASE
words that have mixed case are not spell checked, example: "SpellChecker"
(boolean)- See Also:
-
SPELL_IGNOREINTERNETADDRESSES
words that look like an Internet address are not spell checked, example: "http://www.google.com"
(boolean)- See Also:
-
SPELL_IGNOREDIGITWORDS
words that have digits in them are not spell checked, example: "mach5"
(boolean)- See Also:
-
SPELL_IGNOREMULTIPLEWORDS
I don't know what this does. It doesn't seem to be used
(boolean)- See Also:
-
SPELL_IGNORESENTENCECAPITALIZATION
the first word of a sentence is expected to start with an upper case letter
(boolean)- See Also:
-
-
Constructor Details
-
Configuration
public Configuration()
-
-
Method Details
-
getInteger
Gets one of the integer constants- Parameters:
key
- one of the integer constants defined in this class- Returns:
- int value of the setting
-
getBoolean
Gets one of the boolean constants- Parameters:
key
- one of the boolean constants defined in this class- Returns:
- boolean value of the setting
-
setInteger
Sets one of the integer constants- Parameters:
key
- one of the integer constants defined in this classvalue
- new integer value of the constant
-
setBoolean
Sets one of the boolean constants- Parameters:
key
- one of the boolean constants defined in this classvalue
- new boolean value of this setting
-
getConfiguration
gets a new default Configuration- Returns:
- Configuration
-
getConfiguration
Returns a new instance of a Configuration class- Parameters:
className
- - the class to return, must be based on Configuration- Returns:
- Configuration
-