com.exalead.indexing.analysis.v10

Class LanguageConfiguration

java.lang.Object

com.exalead.indexing.analysis.v10.LanguageConfiguration

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class LanguageConfiguration
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Configuration of the linguistic extraction for a given language.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_GENERATE_WORD_DICT
static int	DEFAULT_MAX_EXTRACTED_SPELL_CHECK_N_GRAM_LENGTH
static int	DEFAULT_MAX_EXTRACTED_WORD_LENGTH
static long	DEFAULT_MAX_RELATED_TERMS_DICT_CONTEXTS_PER_DOCUMENT
static long	DEFAULT_MAX_SPELL_CHECK_N_GRAMS_PER_DOCUMENT
static long	DEFAULT_MAX_WORD_DICT_WORDS_PER_DOCUMENT
static int	DEFAULT_RELATED_TERMS_DICT_MODULO
static int	DEFAULT_SPELL_CHECK_N_GRAM_MAX_SIZE
static int	DEFAULT_SPELL_CHECK_N_GRAMS_DICT_MODULO
static int	DEFAULT_WORD_DICT_MODULO
boolean	generateWordDict
java.lang.String	language
int	maxExtractedSpellCheckNGramLength
int	maxExtractedWordLength
long	maxRelatedTermsDictContextsPerDocument
long	maxSpellCheckNGramsPerDocument
long	maxWordDictWordsPerDocument
int	relatedTermsDictModulo
int	spellCheckNGramMaxSize
int	spellCheckNGramsDictModulo
int	wordDictModulo

Constructor Summary

Constructors

Constructor and Description
LanguageConfiguration()
LanguageConfiguration(LanguageConfiguration o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this LanguageConfiguration.
static LanguageConfiguration	fromString(java.lang.String s) String representation of this LanguageConfiguration.
java.lang.String	getLanguage() The language iso code
int	getMaxExtractedSpellCheckNGramLength() Maximum length an ngram must have to be extracted.
int	getMaxExtractedWordLength() Maximum length a word must have to be extracted.
long	getMaxRelatedTermsDictContextsPerDocument() Maximum number of related terms extracted per document.
long	getMaxSpellCheckNGramsPerDocument() Maximum number of ngrams extracted per document.
long	getMaxWordDictWordsPerDocument() Maximum number of words extracted per document.
int	getRelatedTermsDictModulo() Submits 1 out of X documents for related terms generation. If the value is set to 0, related terms are not generated for this language.
int	getSpellCheckNGramMaxSize() Maximum number of consecutive words for spellchecking. If the value is set to '-1', spellcheck data is not generated for this language. 0 and 1 values are illegal, default is 3.
int	getSpellCheckNGramsDictModulo() NGrams extraction modulo.
int	getWordDictModulo() Word extraction modulo, by default extract all words.
boolean	isGenerateWordDict() Extracts words for the global dictionary.
LanguageConfiguration	makeCopy() Creates and returns a deep copy of this LanguageConfiguration.
static LanguageConfiguration	readFrom(java.io.InputStream is) Read this LanguageConfiguration from an XML fragment.
void	setGenerateWordDict(boolean generateWordDict) Extracts words for the global dictionary.
void	setLanguage(java.lang.String language) The language iso code
void	setMaxExtractedSpellCheckNGramLength(int maxExtractedSpellCheckNGramLength) Maximum length an ngram must have to be extracted.
void	setMaxExtractedWordLength(int maxExtractedWordLength) Maximum length a word must have to be extracted.
void	setMaxRelatedTermsDictContextsPerDocument(long maxRelatedTermsDictContextsPerDocument) Maximum number of related terms extracted per document.
void	setMaxSpellCheckNGramsPerDocument(long maxSpellCheckNGramsPerDocument) Maximum number of ngrams extracted per document.
void	setMaxWordDictWordsPerDocument(long maxWordDictWordsPerDocument) Maximum number of words extracted per document.
void	setRelatedTermsDictModulo(int relatedTermsDictModulo) Submits 1 out of X documents for related terms generation. If the value is set to 0, related terms are not generated for this language.
void	setSpellCheckNGramMaxSize(int spellCheckNGramMaxSize) Maximum number of consecutive words for spellchecking. If the value is set to '-1', spellcheck data is not generated for this language. 0 and 1 values are illegal, default is 3.
void	setSpellCheckNGramsDictModulo(int spellCheckNGramsDictModulo) NGrams extraction modulo.
void	setWordDictModulo(int wordDictModulo) Word extraction modulo, by default extract all words.
java.lang.String	toString() String representation of this LanguageConfiguration.
LanguageConfiguration	withGenerateWordDict(boolean generateWordDict)
LanguageConfiguration	withGenerateWordDict(java.lang.Boolean generateWordDict)
LanguageConfiguration	withLanguage(java.lang.String language)
LanguageConfiguration	withMaxExtractedSpellCheckNGramLength(int maxExtractedSpellCheckNGramLength)
LanguageConfiguration	withMaxExtractedSpellCheckNGramLength(java.lang.Integer maxExtractedSpellCheckNGramLength)
LanguageConfiguration	withMaxExtractedWordLength(int maxExtractedWordLength)
LanguageConfiguration	withMaxExtractedWordLength(java.lang.Integer maxExtractedWordLength)
LanguageConfiguration	withMaxRelatedTermsDictContextsPerDocument(long maxRelatedTermsDictContextsPerDocument)
LanguageConfiguration	withMaxRelatedTermsDictContextsPerDocument(java.lang.Long maxRelatedTermsDictContextsPerDocument)
LanguageConfiguration	withMaxSpellCheckNGramsPerDocument(long maxSpellCheckNGramsPerDocument)
LanguageConfiguration	withMaxSpellCheckNGramsPerDocument(java.lang.Long maxSpellCheckNGramsPerDocument)
LanguageConfiguration	withMaxWordDictWordsPerDocument(long maxWordDictWordsPerDocument)
LanguageConfiguration	withMaxWordDictWordsPerDocument(java.lang.Long maxWordDictWordsPerDocument)
LanguageConfiguration	withRelatedTermsDictModulo(int relatedTermsDictModulo)
LanguageConfiguration	withRelatedTermsDictModulo(java.lang.Integer relatedTermsDictModulo)
LanguageConfiguration	withSpellCheckNGramMaxSize(int spellCheckNGramMaxSize)
LanguageConfiguration	withSpellCheckNGramMaxSize(java.lang.Integer spellCheckNGramMaxSize)
LanguageConfiguration	withSpellCheckNGramsDictModulo(int spellCheckNGramsDictModulo)
LanguageConfiguration	withSpellCheckNGramsDictModulo(java.lang.Integer spellCheckNGramsDictModulo)
LanguageConfiguration	withWordDictModulo(int wordDictModulo)
LanguageConfiguration	withWordDictModulo(java.lang.Integer wordDictModulo)
void	writeTo(java.io.OutputStream os) Write this LanguageConfiguration as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

language

public java.lang.String language

generateWordDict

public boolean generateWordDict

DEFAULT_GENERATE_WORD_DICT

public static final boolean DEFAULT_GENERATE_WORD_DICT

See Also:

Constant Field Values

wordDictModulo

public int wordDictModulo

DEFAULT_WORD_DICT_MODULO

public static final int DEFAULT_WORD_DICT_MODULO

See Also:

Constant Field Values

maxWordDictWordsPerDocument

public long maxWordDictWordsPerDocument

DEFAULT_MAX_WORD_DICT_WORDS_PER_DOCUMENT

public static final long DEFAULT_MAX_WORD_DICT_WORDS_PER_DOCUMENT

See Also:

Constant Field Values

maxExtractedWordLength

public int maxExtractedWordLength

DEFAULT_MAX_EXTRACTED_WORD_LENGTH

public static final int DEFAULT_MAX_EXTRACTED_WORD_LENGTH

See Also:

Constant Field Values

spellCheckNGramMaxSize

public int spellCheckNGramMaxSize

DEFAULT_SPELL_CHECK_N_GRAM_MAX_SIZE

public static final int DEFAULT_SPELL_CHECK_N_GRAM_MAX_SIZE

See Also:

Constant Field Values

spellCheckNGramsDictModulo

public int spellCheckNGramsDictModulo

DEFAULT_SPELL_CHECK_N_GRAMS_DICT_MODULO

public static final int DEFAULT_SPELL_CHECK_N_GRAMS_DICT_MODULO

See Also:

Constant Field Values

maxSpellCheckNGramsPerDocument

public long maxSpellCheckNGramsPerDocument

DEFAULT_MAX_SPELL_CHECK_N_GRAMS_PER_DOCUMENT

public static final long DEFAULT_MAX_SPELL_CHECK_N_GRAMS_PER_DOCUMENT

See Also:

Constant Field Values

maxExtractedSpellCheckNGramLength

public int maxExtractedSpellCheckNGramLength

DEFAULT_MAX_EXTRACTED_SPELL_CHECK_N_GRAM_LENGTH

public static final int DEFAULT_MAX_EXTRACTED_SPELL_CHECK_N_GRAM_LENGTH

See Also:

Constant Field Values

relatedTermsDictModulo

public int relatedTermsDictModulo

DEFAULT_RELATED_TERMS_DICT_MODULO

public static final int DEFAULT_RELATED_TERMS_DICT_MODULO

See Also:

Constant Field Values

maxRelatedTermsDictContextsPerDocument

public long maxRelatedTermsDictContextsPerDocument

DEFAULT_MAX_RELATED_TERMS_DICT_CONTEXTS_PER_DOCUMENT

public static final long DEFAULT_MAX_RELATED_TERMS_DICT_CONTEXTS_PER_DOCUMENT

See Also:

Constant Field Values

Constructor Detail

LanguageConfiguration

public LanguageConfiguration()

LanguageConfiguration

public LanguageConfiguration(LanguageConfiguration o)

Copy constructor

Method Detail

setLanguage

public void setLanguage(java.lang.String language)

The language iso code

getLanguage

public java.lang.String getLanguage()

The language iso code

withLanguage

public LanguageConfiguration withLanguage(java.lang.String language)

setGenerateWordDict

public void setGenerateWordDict(boolean generateWordDict)

Extracts words for the global dictionary.

isGenerateWordDict

public boolean isGenerateWordDict()

Extracts words for the global dictionary.

withGenerateWordDict

public LanguageConfiguration withGenerateWordDict(boolean generateWordDict)

withGenerateWordDict

public LanguageConfiguration withGenerateWordDict(java.lang.Boolean generateWordDict)

setWordDictModulo

public void setWordDictModulo(int wordDictModulo)

Word extraction modulo, by default extract all words.

getWordDictModulo

public int getWordDictModulo()

Word extraction modulo, by default extract all words.

withWordDictModulo

public LanguageConfiguration withWordDictModulo(int wordDictModulo)

withWordDictModulo

public LanguageConfiguration withWordDictModulo(java.lang.Integer wordDictModulo)

setMaxWordDictWordsPerDocument

public void setMaxWordDictWordsPerDocument(long maxWordDictWordsPerDocument)

Maximum number of words extracted per document.

getMaxWordDictWordsPerDocument

public long getMaxWordDictWordsPerDocument()

Maximum number of words extracted per document.

withMaxWordDictWordsPerDocument

public LanguageConfiguration withMaxWordDictWordsPerDocument(long maxWordDictWordsPerDocument)

withMaxWordDictWordsPerDocument

public LanguageConfiguration withMaxWordDictWordsPerDocument(java.lang.Long maxWordDictWordsPerDocument)

setMaxExtractedWordLength

public void setMaxExtractedWordLength(int maxExtractedWordLength)

Maximum length a word must have to be extracted.

getMaxExtractedWordLength

public int getMaxExtractedWordLength()

Maximum length a word must have to be extracted.

withMaxExtractedWordLength

public LanguageConfiguration withMaxExtractedWordLength(int maxExtractedWordLength)

withMaxExtractedWordLength

public LanguageConfiguration withMaxExtractedWordLength(java.lang.Integer maxExtractedWordLength)

setSpellCheckNGramMaxSize

public void setSpellCheckNGramMaxSize(int spellCheckNGramMaxSize)

Maximum number of consecutive words for spellchecking.
If the value is set to '-1', spellcheck data is not generated for this language.
0 and 1 values are illegal, default is 3.

getSpellCheckNGramMaxSize

public int getSpellCheckNGramMaxSize()

Maximum number of consecutive words for spellchecking.
If the value is set to '-1', spellcheck data is not generated for this language.
0 and 1 values are illegal, default is 3.

withSpellCheckNGramMaxSize

public LanguageConfiguration withSpellCheckNGramMaxSize(int spellCheckNGramMaxSize)

withSpellCheckNGramMaxSize

public LanguageConfiguration withSpellCheckNGramMaxSize(java.lang.Integer spellCheckNGramMaxSize)

setSpellCheckNGramsDictModulo

public void setSpellCheckNGramsDictModulo(int spellCheckNGramsDictModulo)

NGrams extraction modulo. It extracts 1 ngram out of 5 by default.

getSpellCheckNGramsDictModulo

public int getSpellCheckNGramsDictModulo()

NGrams extraction modulo. It extracts 1 ngram out of 5 by default.

withSpellCheckNGramsDictModulo

public LanguageConfiguration withSpellCheckNGramsDictModulo(int spellCheckNGramsDictModulo)

withSpellCheckNGramsDictModulo

public LanguageConfiguration withSpellCheckNGramsDictModulo(java.lang.Integer spellCheckNGramsDictModulo)

setMaxSpellCheckNGramsPerDocument

public void setMaxSpellCheckNGramsPerDocument(long maxSpellCheckNGramsPerDocument)

Maximum number of ngrams extracted per document.

getMaxSpellCheckNGramsPerDocument

public long getMaxSpellCheckNGramsPerDocument()

Maximum number of ngrams extracted per document.

withMaxSpellCheckNGramsPerDocument

public LanguageConfiguration withMaxSpellCheckNGramsPerDocument(long maxSpellCheckNGramsPerDocument)

withMaxSpellCheckNGramsPerDocument

public LanguageConfiguration withMaxSpellCheckNGramsPerDocument(java.lang.Long maxSpellCheckNGramsPerDocument)

setMaxExtractedSpellCheckNGramLength

public void setMaxExtractedSpellCheckNGramLength(int maxExtractedSpellCheckNGramLength)

Maximum length an ngram must have to be extracted.

getMaxExtractedSpellCheckNGramLength

public int getMaxExtractedSpellCheckNGramLength()

Maximum length an ngram must have to be extracted.

withMaxExtractedSpellCheckNGramLength

public LanguageConfiguration withMaxExtractedSpellCheckNGramLength(int maxExtractedSpellCheckNGramLength)

withMaxExtractedSpellCheckNGramLength

public LanguageConfiguration withMaxExtractedSpellCheckNGramLength(java.lang.Integer maxExtractedSpellCheckNGramLength)

setRelatedTermsDictModulo

public void setRelatedTermsDictModulo(int relatedTermsDictModulo)

Submits 1 out of X documents for related terms generation.
If the value is set to 0, related terms are not generated for this language.

getRelatedTermsDictModulo

public int getRelatedTermsDictModulo()

Submits 1 out of X documents for related terms generation.
If the value is set to 0, related terms are not generated for this language.

withRelatedTermsDictModulo

public LanguageConfiguration withRelatedTermsDictModulo(int relatedTermsDictModulo)

withRelatedTermsDictModulo

public LanguageConfiguration withRelatedTermsDictModulo(java.lang.Integer relatedTermsDictModulo)

setMaxRelatedTermsDictContextsPerDocument

public void setMaxRelatedTermsDictContextsPerDocument(long maxRelatedTermsDictContextsPerDocument)

Maximum number of related terms extracted per document.

getMaxRelatedTermsDictContextsPerDocument

public long getMaxRelatedTermsDictContextsPerDocument()

Maximum number of related terms extracted per document.

withMaxRelatedTermsDictContextsPerDocument

public LanguageConfiguration withMaxRelatedTermsDictContextsPerDocument(long maxRelatedTermsDictContextsPerDocument)

withMaxRelatedTermsDictContextsPerDocument

public LanguageConfiguration withMaxRelatedTermsDictContextsPerDocument(java.lang.Long maxRelatedTermsDictContextsPerDocument)

makeCopy

public LanguageConfiguration makeCopy()

Creates and returns a deep copy of this LanguageConfiguration.

readFrom

public static LanguageConfiguration readFrom(java.io.InputStream is)
                                      throws javax.xml.bind.JAXBException

Read this LanguageConfiguration from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this LanguageConfiguration as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static LanguageConfiguration fromString(java.lang.String s)
                                        throws javax.xml.bind.JAXBException,
                                               java.io.UnsupportedEncodingException

String representation of this LanguageConfiguration.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this LanguageConfiguration.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this LanguageConfiguration.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException