com.exalead.mercury.mami.search.v20

Class SemanticQueryAnalysisConfig

java.lang.Object

com.exalead.mercury.mami.search.v20.SemanticQueryAnalysisConfig

All Implemented Interfaces:

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

public class SemanticQueryAnalysisConfig
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	SemanticQueryAnalysisConfig.UnusedWordPolicy

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_OVERLAPPING_MATCHES
static java.lang.String	DEFAULT_QUERY_NAMES
static boolean	DEFAULT_SINGLE_MATCH
static java.lang.String	DEFAULT_UNUSED_WORD_POLICY
java.lang.String	htmlLogPath
java.lang.String	language
boolean	overlappingMatches
java.lang.String	queryNames
java.lang.String	resourceDir
java.util.List<SemanticProcessor>	semanticProcessor
boolean	singleMatch
java.lang.String	unusedWordPolicy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SemanticQueryAnalysisConfig.
static SemanticQueryAnalysisConfig	fromString(java.lang.String s) String representation of this SemanticQueryAnalysisConfig.
java.lang.String	getHtmlLogPath() Path to a debug HTML file
java.lang.String	getLanguage() The query language for which the analyzer is activated.
java.lang.String	getQueryNames() A list of comma-separated query names defining which parts of the query will be processed (default is _default_).
java.lang.String	getResourceDir() URL for the directory containing the semantic extractor binaries (data://, file;// or resource://).
java.util.List<SemanticProcessor>	getSemanticProcessor() A list of semantic processor to apply before the semantic extractor.
java.lang.String	getUnusedWordPolicy() Unused query word policy
SemanticQueryAnalysisConfig.UnusedWordPolicy	getUnusedWordPolicyAsEnum() Unused query word policy
static boolean	isA(java.lang.String str, SemanticQueryAnalysisConfig.UnusedWordPolicy item)
static boolean	isOneOf(java.lang.String str, SemanticQueryAnalysisConfig.UnusedWordPolicy... items)
boolean	isOverlappingMatches() If true, allows rules to match on overlapping query parts.
boolean	isSingleMatch() If true, only the best match is selected for rewriting, if false, several rules may trigger simultaneously.
SemanticQueryAnalysisConfig	makeCopy() Creates and returns a deep copy of this SemanticQueryAnalysisConfig.
static SemanticQueryAnalysisConfig	readFrom(java.io.InputStream is) Read this SemanticQueryAnalysisConfig from an XML fragment.
void	setHtmlLogPath(java.lang.String htmlLogPath) Path to a debug HTML file
void	setLanguage(java.lang.String language) The query language for which the analyzer is activated.
void	setOverlappingMatches(boolean overlappingMatches) If true, allows rules to match on overlapping query parts.
void	setQueryNames(java.lang.String queryNames) A list of comma-separated query names defining which parts of the query will be processed (default is _default_).
void	setResourceDir(java.lang.String resourceDir) URL for the directory containing the semantic extractor binaries (data://, file;// or resource://).
void	setSingleMatch(boolean singleMatch) If true, only the best match is selected for rewriting, if false, several rules may trigger simultaneously.
void	setUnusedWordPolicy(SemanticQueryAnalysisConfig.UnusedWordPolicy item) Unused query word policy
void	setUnusedWordPolicy(java.lang.String unusedWordPolicy) Unused query word policy
java.lang.String	toString() String representation of this SemanticQueryAnalysisConfig.
SemanticQueryAnalysisConfig	withHtmlLogPath(java.lang.String htmlLogPath)
SemanticQueryAnalysisConfig	withLanguage(java.lang.String language)
SemanticQueryAnalysisConfig	withOverlappingMatches(boolean overlappingMatches)
SemanticQueryAnalysisConfig	withOverlappingMatches(java.lang.Boolean overlappingMatches)
SemanticQueryAnalysisConfig	withQueryNames(java.lang.String queryNames)
SemanticQueryAnalysisConfig	withResourceDir(java.lang.String resourceDir)
SemanticQueryAnalysisConfig	withSemanticProcessor(java.util.Collection<SemanticProcessor> __values)
SemanticQueryAnalysisConfig	withSemanticProcessor(SemanticProcessor... __values) A list of semantic processor to apply before the semantic extractor.
SemanticQueryAnalysisConfig	withSingleMatch(boolean singleMatch)
SemanticQueryAnalysisConfig	withSingleMatch(java.lang.Boolean singleMatch)
SemanticQueryAnalysisConfig	withUnusedWordPolicy(java.lang.String unusedWordPolicy)
void	writeTo(java.io.OutputStream os) Write this SemanticQueryAnalysisConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

semanticProcessor

public java.util.List<SemanticProcessor> semanticProcessor

resourceDir

public java.lang.String resourceDir

unusedWordPolicy

public java.lang.String unusedWordPolicy

DEFAULT_UNUSED_WORD_POLICY

public static final java.lang.String DEFAULT_UNUSED_WORD_POLICY

See Also:

Constant Field Values

language

public java.lang.String language

queryNames

public java.lang.String queryNames

DEFAULT_QUERY_NAMES

public static final java.lang.String DEFAULT_QUERY_NAMES

See Also:

Constant Field Values

htmlLogPath

public java.lang.String htmlLogPath

singleMatch

public boolean singleMatch

DEFAULT_SINGLE_MATCH

public static final boolean DEFAULT_SINGLE_MATCH

See Also:

Constant Field Values

overlappingMatches

public boolean overlappingMatches

DEFAULT_OVERLAPPING_MATCHES

public static final boolean DEFAULT_OVERLAPPING_MATCHES

See Also:

Constant Field Values

Constructor Detail

SemanticQueryAnalysisConfig

public SemanticQueryAnalysisConfig()

SemanticQueryAnalysisConfig

public SemanticQueryAnalysisConfig(SemanticQueryAnalysisConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          SemanticQueryAnalysisConfig.UnusedWordPolicy item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              SemanticQueryAnalysisConfig.UnusedWordPolicy... items)

setUnusedWordPolicy

public void setUnusedWordPolicy(SemanticQueryAnalysisConfig.UnusedWordPolicy item)

Unused query word policy

getUnusedWordPolicyAsEnum

public SemanticQueryAnalysisConfig.UnusedWordPolicy getUnusedWordPolicyAsEnum()

Unused query word policy

getSemanticProcessor

public java.util.List<SemanticProcessor> getSemanticProcessor()

A list of semantic processor to apply before the semantic extractor.

withSemanticProcessor

public SemanticQueryAnalysisConfig withSemanticProcessor(SemanticProcessor... __values)

A list of semantic processor to apply before the semantic extractor.

withSemanticProcessor

public SemanticQueryAnalysisConfig withSemanticProcessor(java.util.Collection<SemanticProcessor> __values)

setResourceDir

public void setResourceDir(java.lang.String resourceDir)

URL for the directory containing the semantic extractor binaries (data://, file;// or resource://).

getResourceDir

public java.lang.String getResourceDir()

URL for the directory containing the semantic extractor binaries (data://, file;// or resource://).

withResourceDir

public SemanticQueryAnalysisConfig withResourceDir(java.lang.String resourceDir)

setUnusedWordPolicy

public void setUnusedWordPolicy(java.lang.String unusedWordPolicy)

Unused query word policy

getUnusedWordPolicy

public java.lang.String getUnusedWordPolicy()

Unused query word policy

withUnusedWordPolicy

public SemanticQueryAnalysisConfig withUnusedWordPolicy(java.lang.String unusedWordPolicy)

setLanguage

public void setLanguage(java.lang.String language)

The query language for which the analyzer is activated.
If null, it is activated whatever the language.

getLanguage

public java.lang.String getLanguage()

The query language for which the analyzer is activated.
If null, it is activated whatever the language.

withLanguage

public SemanticQueryAnalysisConfig withLanguage(java.lang.String language)

setQueryNames

public void setQueryNames(java.lang.String queryNames)

A list of comma-separated query names defining which parts of the query will be processed (default is _default_).

getQueryNames

public java.lang.String getQueryNames()

A list of comma-separated query names defining which parts of the query will be processed (default is _default_).

withQueryNames

public SemanticQueryAnalysisConfig withQueryNames(java.lang.String queryNames)

setHtmlLogPath

public void setHtmlLogPath(java.lang.String htmlLogPath)

Path to a debug HTML file

getHtmlLogPath

public java.lang.String getHtmlLogPath()

Path to a debug HTML file

withHtmlLogPath

public SemanticQueryAnalysisConfig withHtmlLogPath(java.lang.String htmlLogPath)

setSingleMatch

public void setSingleMatch(boolean singleMatch)

If true, only the best match is selected for rewriting, if false, several rules may trigger simultaneously.

isSingleMatch

public boolean isSingleMatch()

If true, only the best match is selected for rewriting, if false, several rules may trigger simultaneously.

withSingleMatch

public SemanticQueryAnalysisConfig withSingleMatch(boolean singleMatch)

withSingleMatch

public SemanticQueryAnalysisConfig withSingleMatch(java.lang.Boolean singleMatch)

setOverlappingMatches

public void setOverlappingMatches(boolean overlappingMatches)

If true, allows rules to match on overlapping query parts. Only makes sense when singleMatch is false.

isOverlappingMatches

public boolean isOverlappingMatches()

If true, allows rules to match on overlapping query parts. Only makes sense when singleMatch is false.

withOverlappingMatches

public SemanticQueryAnalysisConfig withOverlappingMatches(boolean overlappingMatches)

withOverlappingMatches

public SemanticQueryAnalysisConfig withOverlappingMatches(java.lang.Boolean overlappingMatches)

makeCopy

public SemanticQueryAnalysisConfig makeCopy()

Creates and returns a deep copy of this SemanticQueryAnalysisConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SemanticQueryAnalysisConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SemanticQueryAnalysisConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this SemanticQueryAnalysisConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException