com.exalead.mercury.mami.search.v20

Class UQLConfig

java.lang.Object

com.exalead.mercury.mami.search.v20.UQLConfig

All Implemented Interfaces:

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

public class UQLConfig
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	UQLConfig.MissingPrefixBehaviour

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DEFAULT_LANGUAGE
static java.lang.String	DEFAULT_DEFAULT_PREFIX_HANDLER
static java.lang.String	DEFAULT_MISSING_PREFIX_BEHAVIOUR
static java.lang.String	DEFAULT_PHRASE_QUERY_TRIGGER_CHARS
static java.lang.String	DEFAULT_QUERY_TEMPLATE
java.lang.String	defaultLanguage
java.lang.String	defaultPrefixHandler
LogicRunnerCustomization	logicRunnerCustomization
java.lang.String	missingPrefixBehaviour
com.exalead.search.v30.ParsingConfig	parsingConfig
com.exalead.search.v30.PatternsExpansionConfig	patternsExpansionConfig
java.lang.String	phraseQueryTriggerChars
com.exalead.search.v30.QueryExpansionConfig	queryExpansionConfig
java.util.List<QueryExpansionModule>	queryExpansionModule
java.util.List<QueryPrefixHandler>	queryPrefixHandler
java.lang.String	queryTemplate
SemanticQueryAnalysisConfig	semanticQueryAnalysisConfig
com.exalead.search.v30.SWConfig	sWConfig

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this UQLConfig.
static UQLConfig	fromString(java.lang.String s) String representation of this UQLConfig.
java.lang.String	getDefaultLanguage() Default language of the query
java.lang.String	getDefaultPrefixHandler() Prefix handler to use for content that is not contained within a specific prefix handler.
LogicRunnerCustomization	getLogicRunnerCustomization()
java.lang.String	getMissingPrefixBehaviour() Action to perform when a prefix:value query does not reference a valid prefix: error: fails the query remove: removes the whole prefix node ignore: does as if the query was a "value" without prefix and: performs a query "prefix AND value" replace_by_false: replaces the whole node by a false node
UQLConfig.MissingPrefixBehaviour	getMissingPrefixBehaviourAsEnum() Action to perform when a prefix:value query does not reference a valid prefix: error: fails the query remove: removes the whole prefix node ignore: does as if the query was a "value" without prefix and: performs a query "prefix AND value" replace_by_false: replaces the whole node by a false node
com.exalead.search.v30.ParsingConfig	getParsingConfig()
com.exalead.search.v30.PatternsExpansionConfig	getPatternsExpansionConfig()
java.lang.String	getPhraseQueryTriggerChars() List of chars inside a word that trigger a sequence match, for example, a.b will be rewritten as "a b".
com.exalead.search.v30.QueryExpansionConfig	getQueryExpansionConfig()
java.util.List<QueryExpansionModule>	getQueryExpansionModule()
java.util.Map<java.lang.String,QueryExpansionModule>	getQueryExpansionModuleAsMap() Get the map of QueryExpansionModule, indexed by name
QueryExpansionModule	getQueryExpansionModuleByName(java.lang.String _lookup) Get the QueryExpansionModule for which the name matches _lookup
java.util.List<QueryPrefixHandler>	getQueryPrefixHandler()
java.util.Map<java.lang.String,QueryPrefixHandler>	getQueryPrefixHandlerAsMap() Get the map of QueryPrefixHandler, indexed by name
QueryPrefixHandler	getQueryPrefixHandlerByName(java.lang.String _lookup) Get the QueryPrefixHandler for which the name matches _lookup
java.lang.String	getQueryTemplate() Default query template to use (conjunction of query, refine, security and content restriction by default)
SemanticQueryAnalysisConfig	getSemanticQueryAnalysisConfig() Semantic analysis and rewriting of queries
com.exalead.search.v30.SWConfig	getSWConfig()
static boolean	isA(java.lang.String str, UQLConfig.MissingPrefixBehaviour item)
static boolean	isOneOf(java.lang.String str, UQLConfig.MissingPrefixBehaviour... items)
UQLConfig	makeCopy() Creates and returns a deep copy of this UQLConfig.
static UQLConfig	readFrom(java.io.InputStream is) Read this UQLConfig from an XML fragment.
boolean	removeQueryExpansionModuleByName(java.lang.String _lookup) Removes the QueryExpansionModule for which the name matches _lookup
boolean	removeQueryPrefixHandlerByName(java.lang.String _lookup) Removes the QueryPrefixHandler for which the name matches _lookup
void	setDefaultLanguage(java.lang.String defaultLanguage) Default language of the query
void	setDefaultPrefixHandler(java.lang.String defaultPrefixHandler) Prefix handler to use for content that is not contained within a specific prefix handler.
void	setLogicRunnerCustomization(LogicRunnerCustomization logicRunnerCustomization)
void	setMissingPrefixBehaviour(java.lang.String missingPrefixBehaviour) Action to perform when a prefix:value query does not reference a valid prefix: error: fails the query remove: removes the whole prefix node ignore: does as if the query was a "value" without prefix and: performs a query "prefix AND value" replace_by_false: replaces the whole node by a false node
void	setMissingPrefixBehaviour(UQLConfig.MissingPrefixBehaviour item) Action to perform when a prefix:value query does not reference a valid prefix: error: fails the query remove: removes the whole prefix node ignore: does as if the query was a "value" without prefix and: performs a query "prefix AND value" replace_by_false: replaces the whole node by a false node
void	setParsingConfig(com.exalead.search.v30.ParsingConfig parsingConfig)
void	setPatternsExpansionConfig(com.exalead.search.v30.PatternsExpansionConfig patternsExpansionConfig)
void	setPhraseQueryTriggerChars(java.lang.String phraseQueryTriggerChars) List of chars inside a word that trigger a sequence match, for example, a.b will be rewritten as "a b".
void	setQueryExpansionConfig(com.exalead.search.v30.QueryExpansionConfig queryExpansionConfig)
void	setQueryTemplate(java.lang.String queryTemplate) Default query template to use (conjunction of query, refine, security and content restriction by default)
void	setSemanticQueryAnalysisConfig(SemanticQueryAnalysisConfig semanticQueryAnalysisConfig) Semantic analysis and rewriting of queries
void	setSWConfig(com.exalead.search.v30.SWConfig sWConfig)
java.lang.String	toString() String representation of this UQLConfig.
UQLConfig	withDefaultLanguage(java.lang.String defaultLanguage)
UQLConfig	withDefaultPrefixHandler(java.lang.String defaultPrefixHandler)
UQLConfig	withLogicRunnerCustomization(LogicRunnerCustomization logicRunnerCustomization)
UQLConfig	withMissingPrefixBehaviour(java.lang.String missingPrefixBehaviour)
UQLConfig	withParsingConfig(com.exalead.search.v30.ParsingConfig parsingConfig)
UQLConfig	withPatternsExpansionConfig(com.exalead.search.v30.PatternsExpansionConfig patternsExpansionConfig)
UQLConfig	withPhraseQueryTriggerChars(java.lang.String phraseQueryTriggerChars)
UQLConfig	withQueryExpansionConfig(com.exalead.search.v30.QueryExpansionConfig queryExpansionConfig)
UQLConfig	withQueryExpansionModule(java.util.Collection<QueryExpansionModule> __values)
UQLConfig	withQueryExpansionModule(QueryExpansionModule... __values)
UQLConfig	withQueryPrefixHandler(java.util.Collection<QueryPrefixHandler> __values)
UQLConfig	withQueryPrefixHandler(QueryPrefixHandler... __values)
UQLConfig	withQueryTemplate(java.lang.String queryTemplate)
UQLConfig	withSemanticQueryAnalysisConfig(SemanticQueryAnalysisConfig semanticQueryAnalysisConfig)
UQLConfig	withSWConfig(com.exalead.search.v30.SWConfig sWConfig)
void	writeTo(java.io.OutputStream os) Write this UQLConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

queryPrefixHandler

public java.util.List<QueryPrefixHandler> queryPrefixHandler

queryExpansionModule

public java.util.List<QueryExpansionModule> queryExpansionModule

sWConfig

public com.exalead.search.v30.SWConfig sWConfig

parsingConfig

public com.exalead.search.v30.ParsingConfig parsingConfig

patternsExpansionConfig

public com.exalead.search.v30.PatternsExpansionConfig patternsExpansionConfig

queryExpansionConfig

public com.exalead.search.v30.QueryExpansionConfig queryExpansionConfig

semanticQueryAnalysisConfig

public SemanticQueryAnalysisConfig semanticQueryAnalysisConfig

logicRunnerCustomization

public LogicRunnerCustomization logicRunnerCustomization

defaultPrefixHandler

public java.lang.String defaultPrefixHandler

DEFAULT_DEFAULT_PREFIX_HANDLER

public static final java.lang.String DEFAULT_DEFAULT_PREFIX_HANDLER

See Also:

Constant Field Values

missingPrefixBehaviour

public java.lang.String missingPrefixBehaviour

DEFAULT_MISSING_PREFIX_BEHAVIOUR

public static final java.lang.String DEFAULT_MISSING_PREFIX_BEHAVIOUR

See Also:

Constant Field Values

phraseQueryTriggerChars

public java.lang.String phraseQueryTriggerChars

DEFAULT_PHRASE_QUERY_TRIGGER_CHARS

public static final java.lang.String DEFAULT_PHRASE_QUERY_TRIGGER_CHARS

See Also:

Constant Field Values

queryTemplate

public java.lang.String queryTemplate

DEFAULT_QUERY_TEMPLATE

public static final java.lang.String DEFAULT_QUERY_TEMPLATE

See Also:

Constant Field Values

defaultLanguage

public java.lang.String defaultLanguage

DEFAULT_DEFAULT_LANGUAGE

public static final java.lang.String DEFAULT_DEFAULT_LANGUAGE

See Also:

Constant Field Values

Constructor Detail

UQLConfig

public UQLConfig()

UQLConfig

public UQLConfig(UQLConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          UQLConfig.MissingPrefixBehaviour item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              UQLConfig.MissingPrefixBehaviour... items)

setMissingPrefixBehaviour

public void setMissingPrefixBehaviour(UQLConfig.MissingPrefixBehaviour item)

Action to perform when a prefix:value query does not reference a valid prefix:

• error: fails the query
• remove: removes the whole prefix node
• ignore: does as if the query was a "value" without prefix
• and: performs a query "prefix AND value"
• replace_by_false: replaces the whole node by a false node

getMissingPrefixBehaviourAsEnum

public UQLConfig.MissingPrefixBehaviour getMissingPrefixBehaviourAsEnum()

Action to perform when a prefix:value query does not reference a valid prefix:

• error: fails the query
• remove: removes the whole prefix node
• ignore: does as if the query was a "value" without prefix
• and: performs a query "prefix AND value"
• replace_by_false: replaces the whole node by a false node

getQueryPrefixHandler

public java.util.List<QueryPrefixHandler> getQueryPrefixHandler()

getQueryPrefixHandlerByName

public QueryPrefixHandler getQueryPrefixHandlerByName(java.lang.String _lookup)

Get the QueryPrefixHandler for which the name matches _lookup

Returns:

null if no matching QueryPrefixHandler is found

getQueryPrefixHandlerAsMap

public java.util.Map<java.lang.String,QueryPrefixHandler> getQueryPrefixHandlerAsMap()

Get the map of QueryPrefixHandler, indexed by name

removeQueryPrefixHandlerByName

public boolean removeQueryPrefixHandlerByName(java.lang.String _lookup)

Removes the QueryPrefixHandler for which the name matches _lookup

Returns:

false if no matching QueryPrefixHandler is found, true if one was found

withQueryPrefixHandler

public UQLConfig withQueryPrefixHandler(QueryPrefixHandler... __values)

withQueryPrefixHandler

public UQLConfig withQueryPrefixHandler(java.util.Collection<QueryPrefixHandler> __values)

getQueryExpansionModule

public java.util.List<QueryExpansionModule> getQueryExpansionModule()

getQueryExpansionModuleByName

public QueryExpansionModule getQueryExpansionModuleByName(java.lang.String _lookup)

Get the QueryExpansionModule for which the name matches _lookup

Returns:

null if no matching QueryExpansionModule is found

getQueryExpansionModuleAsMap

public java.util.Map<java.lang.String,QueryExpansionModule> getQueryExpansionModuleAsMap()

Get the map of QueryExpansionModule, indexed by name

removeQueryExpansionModuleByName

public boolean removeQueryExpansionModuleByName(java.lang.String _lookup)

Removes the QueryExpansionModule for which the name matches _lookup

Returns:

false if no matching QueryExpansionModule is found, true if one was found

withQueryExpansionModule

public UQLConfig withQueryExpansionModule(QueryExpansionModule... __values)

withQueryExpansionModule

public UQLConfig withQueryExpansionModule(java.util.Collection<QueryExpansionModule> __values)

setSWConfig

public void setSWConfig(com.exalead.search.v30.SWConfig sWConfig)

getSWConfig

public com.exalead.search.v30.SWConfig getSWConfig()

withSWConfig

public UQLConfig withSWConfig(com.exalead.search.v30.SWConfig sWConfig)

setParsingConfig

public void setParsingConfig(com.exalead.search.v30.ParsingConfig parsingConfig)

getParsingConfig

public com.exalead.search.v30.ParsingConfig getParsingConfig()

withParsingConfig

public UQLConfig withParsingConfig(com.exalead.search.v30.ParsingConfig parsingConfig)

setPatternsExpansionConfig

public void setPatternsExpansionConfig(com.exalead.search.v30.PatternsExpansionConfig patternsExpansionConfig)

getPatternsExpansionConfig

public com.exalead.search.v30.PatternsExpansionConfig getPatternsExpansionConfig()

withPatternsExpansionConfig

public UQLConfig withPatternsExpansionConfig(com.exalead.search.v30.PatternsExpansionConfig patternsExpansionConfig)

setQueryExpansionConfig

public void setQueryExpansionConfig(com.exalead.search.v30.QueryExpansionConfig queryExpansionConfig)

getQueryExpansionConfig

public com.exalead.search.v30.QueryExpansionConfig getQueryExpansionConfig()

withQueryExpansionConfig

public UQLConfig withQueryExpansionConfig(com.exalead.search.v30.QueryExpansionConfig queryExpansionConfig)

setSemanticQueryAnalysisConfig

public void setSemanticQueryAnalysisConfig(SemanticQueryAnalysisConfig semanticQueryAnalysisConfig)

Semantic analysis and rewriting of queries

getSemanticQueryAnalysisConfig

public SemanticQueryAnalysisConfig getSemanticQueryAnalysisConfig()

Semantic analysis and rewriting of queries

withSemanticQueryAnalysisConfig

public UQLConfig withSemanticQueryAnalysisConfig(SemanticQueryAnalysisConfig semanticQueryAnalysisConfig)

setLogicRunnerCustomization

public void setLogicRunnerCustomization(LogicRunnerCustomization logicRunnerCustomization)

getLogicRunnerCustomization

public LogicRunnerCustomization getLogicRunnerCustomization()

withLogicRunnerCustomization

public UQLConfig withLogicRunnerCustomization(LogicRunnerCustomization logicRunnerCustomization)

setDefaultPrefixHandler

public void setDefaultPrefixHandler(java.lang.String defaultPrefixHandler)

Prefix handler to use for content that is not contained within
a specific prefix handler.

getDefaultPrefixHandler

public java.lang.String getDefaultPrefixHandler()

Prefix handler to use for content that is not contained within
a specific prefix handler.

withDefaultPrefixHandler

public UQLConfig withDefaultPrefixHandler(java.lang.String defaultPrefixHandler)

setMissingPrefixBehaviour

public void setMissingPrefixBehaviour(java.lang.String missingPrefixBehaviour)

Action to perform when a prefix:value query does not reference a valid prefix:

• error: fails the query
• remove: removes the whole prefix node
• ignore: does as if the query was a "value" without prefix
• and: performs a query "prefix AND value"
• replace_by_false: replaces the whole node by a false node

getMissingPrefixBehaviour

public java.lang.String getMissingPrefixBehaviour()

Action to perform when a prefix:value query does not reference a valid prefix:

• error: fails the query
• remove: removes the whole prefix node
• ignore: does as if the query was a "value" without prefix
• and: performs a query "prefix AND value"
• replace_by_false: replaces the whole node by a false node

withMissingPrefixBehaviour

public UQLConfig withMissingPrefixBehaviour(java.lang.String missingPrefixBehaviour)

setPhraseQueryTriggerChars

public void setPhraseQueryTriggerChars(java.lang.String phraseQueryTriggerChars)

List of chars inside a word that trigger a sequence match,
for example, a.b will be rewritten as "a b".

getPhraseQueryTriggerChars

public java.lang.String getPhraseQueryTriggerChars()

List of chars inside a word that trigger a sequence match,
for example, a.b will be rewritten as "a b".

withPhraseQueryTriggerChars

public UQLConfig withPhraseQueryTriggerChars(java.lang.String phraseQueryTriggerChars)

setQueryTemplate

public void setQueryTemplate(java.lang.String queryTemplate)

Default query template to use (conjunction of query, refine, security and content restriction by default)

getQueryTemplate

public java.lang.String getQueryTemplate()

Default query template to use (conjunction of query, refine, security and content restriction by default)

withQueryTemplate

public UQLConfig withQueryTemplate(java.lang.String queryTemplate)

setDefaultLanguage

public void setDefaultLanguage(java.lang.String defaultLanguage)

Default language of the query

getDefaultLanguage

public java.lang.String getDefaultLanguage()

Default language of the query

withDefaultLanguage

public UQLConfig withDefaultLanguage(java.lang.String defaultLanguage)

makeCopy

public UQLConfig makeCopy()

Creates and returns a deep copy of this UQLConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this UQLConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this UQLConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this UQLConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException