public static final class

DidYouMean.Constants

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

Summary

Constants
int BUNDLED_DICTIONARY_SIZE
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.

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.
String INDEX_DIR Name of index directory
int MAX_BODY_GRAM_SIZE
int MAX_EDGE_GRAM_SIZE
int MAX_INPUT_WORD_LENGTH Maximum length of word for which an attempt will be made to find suggestions for.
int MIN_BODY_GRAM_SIZE
int MIN_EDGE_GRAM_SIZE
int MIN_REQUIRED_FREQ_RATIO
int MIN_WORD_LENGTH The minimum length word that will be considered for n-gram indexing.
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.
Public Constructors
DidYouMean.Constants()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int BUNDLED_DICTIONARY_SIZE

Constant Value: 120880 (0x0001d830)

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

Constant Value: 25000 (0x000061a8)

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.

Constant Value: 1 (0x00000001)

public static final String INDEX_DIR

Name of index directory

Constant Value: "didyoumean"

public static final int MAX_BODY_GRAM_SIZE

Constant Value: 2 (0x00000002)

public static final int MAX_EDGE_GRAM_SIZE

Constant Value: 2 (0x00000002)

public static final int MAX_INPUT_WORD_LENGTH

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

Constant Value: 100 (0x00000064)

public static final int MIN_BODY_GRAM_SIZE

Constant Value: 2 (0x00000002)

public static final int MIN_EDGE_GRAM_SIZE

Constant Value: 2 (0x00000002)

public static final int MIN_REQUIRED_FREQ_RATIO

Constant Value: 20 (0x00000014)

public static final int MIN_WORD_LENGTH

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

Constant Value: 3 (0x00000003)

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.

Constant Value: 10 (0x0000000a)

Public Constructors

public DidYouMean.Constants ()