net.yacy.cora.document

Class WordCache

java.lang.Object

net.yacy.cora.document.WordCache

public class WordCache
extends java.lang.Object

provide a completion library for the did-you-mean class

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WordCache.Dictionary

Field Summary

Fields

Modifier and Type	Field and Description
private static OrderedScoreMap<java.lang.StringBuilder>	commonWords
private static int	commonWordsMaxSize
private static int	commonWordsMinLength
(package private) java.util.Map<java.lang.String,WordCache.Dictionary>	dictionaries
private java.io.File	dictionaryPath
private static ConcurrentLog	log

Constructor Summary

Constructors

Constructor and Description
WordCache(java.io.File dictionaryPath) create a new dictionary This loads all files that ends with '.words' The files must have one word per line Comment lines may be given and are encoded as line starting with '#'

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearCommonWords()
boolean	contains(java.lang.StringBuilder s) check if the library contains the given word
java.util.Map<java.lang.String,WordCache.Dictionary>	getDictionaries()
boolean	isRelevant(int minimumWords) a property that is used during the construction of recommendation: if the dictionary is too small, then the non-existence of constructed words is not relevant for the construction of artificially constructed words If this property returns true, all other words must be in the dictionary
static void	learn(java.util.Collection<java.lang.String> wordset)
static void	learn(java.lang.StringBuilder word) add a word to the generic dictionary
java.util.Set<java.lang.StringBuilder>	recommend(java.lang.StringBuilder string) read the dictionary and construct a set of recommendations to a given string
void	reload() scan the input directory and load all dictionaries (again)
private static java.lang.StringBuilder	reverse(java.lang.StringBuilder s)
int	size() the size of the dictionary
static int	sizeCommonWords()
boolean	supports(java.lang.StringBuilder string) check if the library supports the given word A word is supported, if the library contains a word that starts or ends with the given word

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final ConcurrentLog log

commonWordsMaxSize

private static final int commonWordsMaxSize

See Also:

Constant Field Values

commonWordsMinLength

private static final int commonWordsMinLength

See Also:

Constant Field Values

commonWords

private static OrderedScoreMap<java.lang.StringBuilder> commonWords

dictionaryPath

private final java.io.File dictionaryPath

dictionaries

final java.util.Map<java.lang.String,WordCache.Dictionary> dictionaries

Constructor Detail

WordCache

public WordCache(java.io.File dictionaryPath)

create a new dictionary This loads all files that ends with '.words' The files must have one word per line Comment lines may be given and are encoded as line starting with '#'

Parameters:

dictionaryPath - path to a directory with library files

Method Detail

getDictionaries

public java.util.Map<java.lang.String,WordCache.Dictionary> getDictionaries()

learn

public static void learn(java.lang.StringBuilder word)

add a word to the generic dictionary

Parameters:

word -

learn

public static void learn(java.util.Collection<java.lang.String> wordset)

reload

public void reload()

scan the input directory and load all dictionaries (again)

reverse

private static java.lang.StringBuilder reverse(java.lang.StringBuilder s)

recommend

public java.util.Set<java.lang.StringBuilder> recommend(java.lang.StringBuilder string)

read the dictionary and construct a set of recommendations to a given string

Parameters:

s - input value that is used to match recommendations

Returns:

set that contains all words that start or end with the input value

contains

public boolean contains(java.lang.StringBuilder s)

check if the library contains the given word

Parameters:

s - the given word

Returns:

true if the library contains the word

supports

public boolean supports(java.lang.StringBuilder string)

check if the library supports the given word A word is supported, if the library contains a word that starts or ends with the given word

Parameters:

s - the given word

Returns:

true if the library supports the word

size

public int size()

the size of the dictionary

Returns:

the number of words in the dictionary

sizeCommonWords

public static int sizeCommonWords()

clearCommonWords

public static void clearCommonWords()

isRelevant

public boolean isRelevant(int minimumWords)

a property that is used during the construction of recommendation: if the dictionary is too small, then the non-existence of constructed words is not relevant for the construction of artificially constructed words If this property returns true, all other words must be in the dictionary

Parameters:

minimumWords -

Returns: