com.atlassian.confluence.search.didyoumean
Class DidYouMean.Constants

java.lang.Object
  com.atlassian.confluence.search.didyoumean.DidYouMean.Constants

Enclosing class:

DidYouMean

public static final class DidYouMean.Constants
extends Object

Field Summary

static int	BUNDLED_DICTIONARY_SIZE
static int	CONFLUENCE_VOCABULARY_SIZE_ESTIMATE An estimate on the number of unique words found from mining Confluence content that is not already contained in the dictionary.
static int	DEFAULT_DICTIONARY_WORD_FREQ The default frequency given to words that come from the bundled dictionary that do not appear in Confluence's index.
static String	INDEX_DIR Name of index directory
static int	MAX_BODY_GRAM_SIZE
static int	MAX_EDGE_GRAM_SIZE
static int	MAX_INPUT_WORD_LENGTH Maximum length of word for which an attempt will be made to find suggestions for.
static int	MIN_BODY_GRAM_SIZE
static int	MIN_EDGE_GRAM_SIZE
static int	MIN_REQUIRED_FREQ_RATIO
static int	MIN_WORD_LENGTH The minimum length word that will be considered for n-gram indexing.
static int	WORD_FREQ_FACTOR The factor that defines how many times a suggestion must occur more frequently than a vocabulary word before we dare suggest it.

Constructor Summary

DidYouMean.Constants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

MIN_EDGE_GRAM_SIZE

public static final int MIN_EDGE_GRAM_SIZE

See Also:

Constant Field Values

MAX_EDGE_GRAM_SIZE

public static final int MAX_EDGE_GRAM_SIZE

See Also:

Constant Field Values

MIN_BODY_GRAM_SIZE

public static final int MIN_BODY_GRAM_SIZE

See Also:

Constant Field Values

MAX_BODY_GRAM_SIZE

public static final int MAX_BODY_GRAM_SIZE

See Also:

Constant Field Values

DEFAULT_DICTIONARY_WORD_FREQ

public static final int DEFAULT_DICTIONARY_WORD_FREQ

The default frequency given to words that come from the bundled dictionary that do not appear in Confluence's index. This frequency is given to allow these words to be considered even though they have not been used in any documents.

See Also:

Constant Field Values

MAX_INPUT_WORD_LENGTH

public static final int MAX_INPUT_WORD_LENGTH

Maximum length of word for which an attempt will be made to find suggestions for.

See Also:

Constant Field Values

BUNDLED_DICTIONARY_SIZE

public static final int BUNDLED_DICTIONARY_SIZE

See Also:

Constant Field Values

CONFLUENCE_VOCABULARY_SIZE_ESTIMATE

public static final int CONFLUENCE_VOCABULARY_SIZE_ESTIMATE

An estimate on the number of unique words found from mining Confluence content that is not already contained in the dictionary. The estimate has been arrived at by taking the average number of words considered to be in common usage according to Oxford dictionary. Of course some of these would already be accounted for in the bundled dictionary (but we can't simply subtract because the bundled dictionary also includes alternate forms of words such as -ing, -s, etc.)

This estimate is intended to be used to help with setting the initial capacities of collections to minimise reallocation only

See Also:

Constant Field Values

INDEX_DIR

public static final String INDEX_DIR

Name of index directory

See Also:

Constant Field Values

MIN_REQUIRED_FREQ_RATIO

public static final int MIN_REQUIRED_FREQ_RATIO

See Also:

Constant Field Values

WORD_FREQ_FACTOR

public static final int WORD_FREQ_FACTOR

The factor that defines how many times a suggestion must occur more frequently than a vocabulary word before we dare suggest it.

See Also:

Constant Field Values

MIN_WORD_LENGTH

public static final int MIN_WORD_LENGTH

The minimum length word that will be considered for n-gram indexing.

See Also:

Constant Field Values

Constructor Detail

DidYouMean.Constants

public DidYouMean.Constants()