com.exalead.search.v30

Class QueryExpansionConfig

java.lang.Object

com.exalead.search.v30.QueryExpansionConfig

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryExpansionConfig.UnavailableDictionaryAction
static class	QueryExpansionConfig.UnavailableDictionaryReportMode

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DETECT_C_J
static java.lang.String	DEFAULT_EXACT_PHRASE_EXPANSION_MODULES_BLACK_LIST
static boolean	DEFAULT_LANG_DETECT
static double	DEFAULT_LANG_DETECT_THRESHOLD
static int	DEFAULT_LONG_FORMS_PRUNING_THRESHOLD
static boolean	DEFAULT_PERFORM_EXACT_PHRASE_EXPANSION
static int	DEFAULT_TIMEOUT_M_S
static java.lang.String	DEFAULT_UNAVAILABLE_DICTIONARY_ACTION
static java.lang.String	DEFAULT_UNAVAILABLE_DICTIONARY_REPORT_MODE
boolean	detectCJ
java.lang.String	exactPhraseExpansionModulesBlackList
boolean	langDetect
LangDetectMapping	langDetectMapping
double	langDetectThreshold
int	longFormsPruningThreshold
boolean	performExactPhraseExpansion
int	timeoutMS
java.lang.String	unavailableDictionaryAction
java.lang.String	unavailableDictionaryReportMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this QueryExpansionConfig.
static QueryExpansionConfig	fromString(java.lang.String s) String representation of this QueryExpansionConfig.
java.lang.String	getExactPhraseExpansionModulesBlackList() If performExactPhraseExpansion is true, this list of comma-separated query expansion module names defines which modules are disabled when expanding exact phrases.
LangDetectMapping	getLangDetectMapping()
double	getLangDetectThreshold() If langDetect is True, it tries to detect the text language.
int	getLongFormsPruningThreshold() Prunes forms spanning several shorter forms from query nodes larger than N tokens, to avoid combination.
int	getTimeoutMS()
java.lang.String	getUnavailableDictionaryAction() Action to execute if the dictionary cannot be contacted for expansion.
QueryExpansionConfig.UnavailableDictionaryAction	getUnavailableDictionaryActionAsEnum() Action to execute if the dictionary cannot be contacted for expansion.
java.lang.String	getUnavailableDictionaryReportMode() Value can be null or one of quiet global local
QueryExpansionConfig.UnavailableDictionaryReportMode	getUnavailableDictionaryReportModeAsEnum() Value can be null or one of quiet global local
static boolean	isA(java.lang.String str, QueryExpansionConfig.UnavailableDictionaryAction item)
static boolean	isA(java.lang.String str, QueryExpansionConfig.UnavailableDictionaryReportMode item)
boolean	isDetectCJ() Tries to detect Chinese and Japanese in the query and override the language of the request accordingly. If false, it uses the user-specified language for expansion.
boolean	isLangDetect() Tries to detect the text language from its unicode range. If false, it uses the user-specified language for expansion (xx is the default one).
static boolean	isOneOf(java.lang.String str, QueryExpansionConfig.UnavailableDictionaryAction... items)
static boolean	isOneOf(java.lang.String str, QueryExpansionConfig.UnavailableDictionaryReportMode... items)
boolean	isPerformExactPhraseExpansion() Activates query expansion on expressions contained within quotation marks. In this case, a number of query expansion modules can be disabled by exactPhraseExpansionModulesBlackList.
QueryExpansionConfig	makeCopy() Creates and returns a deep copy of this QueryExpansionConfig.
static QueryExpansionConfig	readFrom(java.io.InputStream is) Read this QueryExpansionConfig from an XML fragment.
void	setDetectCJ(boolean detectCJ) Tries to detect Chinese and Japanese in the query and override the language of the request accordingly. If false, it uses the user-specified language for expansion.
void	setExactPhraseExpansionModulesBlackList(java.lang.String exactPhraseExpansionModulesBlackList) If performExactPhraseExpansion is true, this list of comma-separated query expansion module names defines which modules are disabled when expanding exact phrases.
void	setLangDetect(boolean langDetect) Tries to detect the text language from its unicode range. If false, it uses the user-specified language for expansion (xx is the default one).
void	setLangDetectMapping(LangDetectMapping langDetectMapping)
void	setLangDetectThreshold(double langDetectThreshold) If langDetect is True, it tries to detect the text language.
void	setLongFormsPruningThreshold(int longFormsPruningThreshold) Prunes forms spanning several shorter forms from query nodes larger than N tokens, to avoid combination.
void	setPerformExactPhraseExpansion(boolean performExactPhraseExpansion) Activates query expansion on expressions contained within quotation marks. In this case, a number of query expansion modules can be disabled by exactPhraseExpansionModulesBlackList.
void	setTimeoutMS(int timeoutMS)
void	setUnavailableDictionaryAction(QueryExpansionConfig.UnavailableDictionaryAction item) Action to execute if the dictionary cannot be contacted for expansion.
void	setUnavailableDictionaryAction(java.lang.String unavailableDictionaryAction) Action to execute if the dictionary cannot be contacted for expansion.
void	setUnavailableDictionaryReportMode(QueryExpansionConfig.UnavailableDictionaryReportMode item) Value can be null or one of quiet global local
void	setUnavailableDictionaryReportMode(java.lang.String unavailableDictionaryReportMode) Value can be null or one of quiet global local
java.lang.String	toString() String representation of this QueryExpansionConfig.
QueryExpansionConfig	withDetectCJ(boolean detectCJ)
QueryExpansionConfig	withDetectCJ(java.lang.Boolean detectCJ)
QueryExpansionConfig	withExactPhraseExpansionModulesBlackList(java.lang.String exactPhraseExpansionModulesBlackList)
QueryExpansionConfig	withLangDetect(boolean langDetect)
QueryExpansionConfig	withLangDetect(java.lang.Boolean langDetect)
QueryExpansionConfig	withLangDetectMapping(LangDetectMapping langDetectMapping)
QueryExpansionConfig	withLangDetectThreshold(double langDetectThreshold)
QueryExpansionConfig	withLongFormsPruningThreshold(int longFormsPruningThreshold)
QueryExpansionConfig	withLongFormsPruningThreshold(java.lang.Integer longFormsPruningThreshold)
QueryExpansionConfig	withPerformExactPhraseExpansion(boolean performExactPhraseExpansion)
QueryExpansionConfig	withPerformExactPhraseExpansion(java.lang.Boolean performExactPhraseExpansion)
QueryExpansionConfig	withTimeoutMS(int timeoutMS)
QueryExpansionConfig	withTimeoutMS(java.lang.Integer timeoutMS)
QueryExpansionConfig	withUnavailableDictionaryAction(java.lang.String unavailableDictionaryAction)
QueryExpansionConfig	withUnavailableDictionaryReportMode(java.lang.String unavailableDictionaryReportMode)
void	writeTo(java.io.OutputStream os) Write this QueryExpansionConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

timeoutMS

public int timeoutMS

DEFAULT_TIMEOUT_M_S

public static final int DEFAULT_TIMEOUT_M_S

See Also:

Constant Field Values

unavailableDictionaryAction

public java.lang.String unavailableDictionaryAction

DEFAULT_UNAVAILABLE_DICTIONARY_ACTION

public static final java.lang.String DEFAULT_UNAVAILABLE_DICTIONARY_ACTION

See Also:

Constant Field Values

unavailableDictionaryReportMode

public java.lang.String unavailableDictionaryReportMode

DEFAULT_UNAVAILABLE_DICTIONARY_REPORT_MODE

public static final java.lang.String DEFAULT_UNAVAILABLE_DICTIONARY_REPORT_MODE

See Also:

Constant Field Values

detectCJ

public boolean detectCJ

DEFAULT_DETECT_C_J

public static final boolean DEFAULT_DETECT_C_J

See Also:

Constant Field Values

langDetect

public boolean langDetect

DEFAULT_LANG_DETECT

public static final boolean DEFAULT_LANG_DETECT

See Also:

Constant Field Values

langDetectThreshold

public double langDetectThreshold

DEFAULT_LANG_DETECT_THRESHOLD

public static final double DEFAULT_LANG_DETECT_THRESHOLD

See Also:

Constant Field Values

langDetectMapping

public LangDetectMapping langDetectMapping

longFormsPruningThreshold

public int longFormsPruningThreshold

DEFAULT_LONG_FORMS_PRUNING_THRESHOLD

public static final int DEFAULT_LONG_FORMS_PRUNING_THRESHOLD

See Also:

Constant Field Values

performExactPhraseExpansion

public boolean performExactPhraseExpansion

DEFAULT_PERFORM_EXACT_PHRASE_EXPANSION

public static final boolean DEFAULT_PERFORM_EXACT_PHRASE_EXPANSION

See Also:

Constant Field Values

exactPhraseExpansionModulesBlackList

public java.lang.String exactPhraseExpansionModulesBlackList

DEFAULT_EXACT_PHRASE_EXPANSION_MODULES_BLACK_LIST

public static final java.lang.String DEFAULT_EXACT_PHRASE_EXPANSION_MODULES_BLACK_LIST

See Also:

Constant Field Values

Constructor Detail

QueryExpansionConfig

public QueryExpansionConfig()

QueryExpansionConfig

public QueryExpansionConfig(QueryExpansionConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          QueryExpansionConfig.UnavailableDictionaryAction item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              QueryExpansionConfig.UnavailableDictionaryAction... items)

setUnavailableDictionaryAction

public void setUnavailableDictionaryAction(QueryExpansionConfig.UnavailableDictionaryAction item)

Action to execute if the dictionary cannot be contacted for expansion.

• error: fails the query
• ignore: does not perform expansion, then continues

getUnavailableDictionaryActionAsEnum

public QueryExpansionConfig.UnavailableDictionaryAction getUnavailableDictionaryActionAsEnum()

Action to execute if the dictionary cannot be contacted for expansion.

• error: fails the query
• ignore: does not perform expansion, then continues

isA

public static boolean isA(java.lang.String str,
                          QueryExpansionConfig.UnavailableDictionaryReportMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              QueryExpansionConfig.UnavailableDictionaryReportMode... items)

setUnavailableDictionaryReportMode

public void setUnavailableDictionaryReportMode(QueryExpansionConfig.UnavailableDictionaryReportMode item)

Value can be null or one of

• quiet
• global
• local

getUnavailableDictionaryReportModeAsEnum

public QueryExpansionConfig.UnavailableDictionaryReportMode getUnavailableDictionaryReportModeAsEnum()

Value can be null or one of

• quiet
• global
• local

setTimeoutMS

public void setTimeoutMS(int timeoutMS)

getTimeoutMS

public int getTimeoutMS()

withTimeoutMS

public QueryExpansionConfig withTimeoutMS(int timeoutMS)

withTimeoutMS

public QueryExpansionConfig withTimeoutMS(java.lang.Integer timeoutMS)

setUnavailableDictionaryAction

public void setUnavailableDictionaryAction(java.lang.String unavailableDictionaryAction)

Action to execute if the dictionary cannot be contacted for expansion.

• error: fails the query
• ignore: does not perform expansion, then continues

getUnavailableDictionaryAction

public java.lang.String getUnavailableDictionaryAction()

Action to execute if the dictionary cannot be contacted for expansion.

• error: fails the query
• ignore: does not perform expansion, then continues

withUnavailableDictionaryAction

public QueryExpansionConfig withUnavailableDictionaryAction(java.lang.String unavailableDictionaryAction)

setUnavailableDictionaryReportMode

public void setUnavailableDictionaryReportMode(java.lang.String unavailableDictionaryReportMode)

Value can be null or one of

• quiet
• global
• local

getUnavailableDictionaryReportMode

public java.lang.String getUnavailableDictionaryReportMode()

Value can be null or one of

• quiet
• global
• local

withUnavailableDictionaryReportMode

public QueryExpansionConfig withUnavailableDictionaryReportMode(java.lang.String unavailableDictionaryReportMode)

setDetectCJ

public void setDetectCJ(boolean detectCJ)

Tries to detect Chinese and Japanese in the query and override the language of the request accordingly.
If false, it uses the user-specified language for expansion.

isDetectCJ

public boolean isDetectCJ()

Tries to detect Chinese and Japanese in the query and override the language of the request accordingly.
If false, it uses the user-specified language for expansion.

withDetectCJ

public QueryExpansionConfig withDetectCJ(boolean detectCJ)

withDetectCJ

public QueryExpansionConfig withDetectCJ(java.lang.Boolean detectCJ)

setLangDetect

public void setLangDetect(boolean langDetect)

Tries to detect the text language from its unicode range.
If false, it uses the user-specified language for expansion (xx is the default one).

isLangDetect

public boolean isLangDetect()

Tries to detect the text language from its unicode range.
If false, it uses the user-specified language for expansion (xx is the default one).

withLangDetect

public QueryExpansionConfig withLangDetect(boolean langDetect)

withLangDetect

public QueryExpansionConfig withLangDetect(java.lang.Boolean langDetect)

setLangDetectThreshold

public void setLangDetectThreshold(double langDetectThreshold)

If langDetect is True, it tries to detect the text language.
That language will be used only if its proportion is superior to langDetectThreshold of the string length

getLangDetectThreshold

public double getLangDetectThreshold()

If langDetect is True, it tries to detect the text language.
That language will be used only if its proportion is superior to langDetectThreshold of the string length

withLangDetectThreshold

public QueryExpansionConfig withLangDetectThreshold(double langDetectThreshold)

setLangDetectMapping

public void setLangDetectMapping(LangDetectMapping langDetectMapping)

getLangDetectMapping

public LangDetectMapping getLangDetectMapping()

withLangDetectMapping

public QueryExpansionConfig withLangDetectMapping(LangDetectMapping langDetectMapping)

setLongFormsPruningThreshold

public void setLongFormsPruningThreshold(int longFormsPruningThreshold)

Prunes forms spanning several shorter forms from query nodes larger than N tokens, to avoid combination.

getLongFormsPruningThreshold

public int getLongFormsPruningThreshold()

Prunes forms spanning several shorter forms from query nodes larger than N tokens, to avoid combination.

withLongFormsPruningThreshold

public QueryExpansionConfig withLongFormsPruningThreshold(int longFormsPruningThreshold)

withLongFormsPruningThreshold

public QueryExpansionConfig withLongFormsPruningThreshold(java.lang.Integer longFormsPruningThreshold)

setPerformExactPhraseExpansion

public void setPerformExactPhraseExpansion(boolean performExactPhraseExpansion)

Activates query expansion on expressions contained within quotation marks.
In this case, a number of query expansion modules can be disabled by exactPhraseExpansionModulesBlackList.

isPerformExactPhraseExpansion

public boolean isPerformExactPhraseExpansion()

Activates query expansion on expressions contained within quotation marks.
In this case, a number of query expansion modules can be disabled by exactPhraseExpansionModulesBlackList.

withPerformExactPhraseExpansion

public QueryExpansionConfig withPerformExactPhraseExpansion(boolean performExactPhraseExpansion)

withPerformExactPhraseExpansion

public QueryExpansionConfig withPerformExactPhraseExpansion(java.lang.Boolean performExactPhraseExpansion)

setExactPhraseExpansionModulesBlackList

public void setExactPhraseExpansionModulesBlackList(java.lang.String exactPhraseExpansionModulesBlackList)

If performExactPhraseExpansion is true, this list of comma-separated query expansion module names defines which modules are disabled when expanding exact phrases.

getExactPhraseExpansionModulesBlackList

public java.lang.String getExactPhraseExpansionModulesBlackList()

If performExactPhraseExpansion is true, this list of comma-separated query expansion module names defines which modules are disabled when expanding exact phrases.

withExactPhraseExpansionModulesBlackList

public QueryExpansionConfig withExactPhraseExpansionModulesBlackList(java.lang.String exactPhraseExpansionModulesBlackList)

makeCopy

public QueryExpansionConfig makeCopy()

Creates and returns a deep copy of this QueryExpansionConfig.

readFrom

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

Read this QueryExpansionConfig 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 QueryExpansionConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this QueryExpansionConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this QueryExpansionConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this QueryExpansionConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException