com.exalead.mercury.mami.search.v20

Class SynonymsModule

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryExpansionModule

com.exalead.mercury.mami.search.v20.SynonymsModule

All Implemented Interfaces:

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

public class SynonymsModule
extends QueryExpansionModule
implements com.exalead.util.Checkable, java.io.Serializable

Synonyms module broadening the scope of a user query.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

QueryExpansionModule.Transformer<T>, QueryExpansionModule.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_SCORE_MULTI_WORDS_EXPRESSIONS_AS_SINGLE_WORDS
java.lang.String	resourceFile
boolean	scoreMultiWordsExpressionsAsSingleWords

Fields inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(QueryExpansionModule.Transformer<T> transformer, T[] t)
void	accept(QueryExpansionModule.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SynonymsModule.
static SynonymsModule	fromString(java.lang.String s) String representation of this SynonymsModule.
java.lang.String	getResourceFile() The compiled synonyms configuration file, cannot be null.
boolean	isScoreMultiWordsExpressionsAsSingleWords() If true, the multi-words synonym will have the maximum score of the underlying words multiplied by the number of original words spanned. By default, the sum is calculated.
SynonymsModule	makeCopy() Creates and returns a deep copy of this SynonymsModule.
static SynonymsModule	readFrom(java.io.InputStream is) Read this SynonymsModule from an XML fragment.
void	setResourceFile(java.lang.String resourceFile) The compiled synonyms configuration file, cannot be null.
void	setScoreMultiWordsExpressionsAsSingleWords(boolean scoreMultiWordsExpressionsAsSingleWords) If true, the multi-words synonym will have the maximum score of the underlying words multiplied by the number of original words spanned. By default, the sum is calculated.
java.lang.String	toString() String representation of this SynonymsModule.
SynonymsModule	withName(java.lang.String name)
SynonymsModule	withResourceFile(java.lang.String resourceFile)
SynonymsModule	withScoreMultiWordsExpressionsAsSingleWords(boolean scoreMultiWordsExpressionsAsSingleWords)
SynonymsModule	withScoreMultiWordsExpressionsAsSingleWords(java.lang.Boolean scoreMultiWordsExpressionsAsSingleWords)
void	writeTo(java.io.OutputStream os) Write this SynonymsModule as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

getName, setName

Methods inherited from class java.lang.Object

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

Field Detail

resourceFile

public java.lang.String resourceFile

scoreMultiWordsExpressionsAsSingleWords

public boolean scoreMultiWordsExpressionsAsSingleWords

DEFAULT_SCORE_MULTI_WORDS_EXPRESSIONS_AS_SINGLE_WORDS

public static final boolean DEFAULT_SCORE_MULTI_WORDS_EXPRESSIONS_AS_SINGLE_WORDS

See Also:

Constant Field Values

Constructor Detail

SynonymsModule

public SynonymsModule()

SynonymsModule

public SynonymsModule(SynonymsModule o)

Copy constructor

Method Detail

withName

public SynonymsModule withName(java.lang.String name)

Overrides:

withName in class QueryExpansionModule

setResourceFile

public void setResourceFile(java.lang.String resourceFile)

The compiled synonyms configuration file, cannot be null.

getResourceFile

public java.lang.String getResourceFile()

The compiled synonyms configuration file, cannot be null.

withResourceFile

public SynonymsModule withResourceFile(java.lang.String resourceFile)

setScoreMultiWordsExpressionsAsSingleWords

public void setScoreMultiWordsExpressionsAsSingleWords(boolean scoreMultiWordsExpressionsAsSingleWords)

If true, the multi-words synonym will have the maximum score of the underlying words multiplied by the number of original words spanned.
By default, the sum is calculated.

isScoreMultiWordsExpressionsAsSingleWords

public boolean isScoreMultiWordsExpressionsAsSingleWords()

If true, the multi-words synonym will have the maximum score of the underlying words multiplied by the number of original words spanned.
By default, the sum is calculated.

withScoreMultiWordsExpressionsAsSingleWords

public SynonymsModule withScoreMultiWordsExpressionsAsSingleWords(boolean scoreMultiWordsExpressionsAsSingleWords)

withScoreMultiWordsExpressionsAsSingleWords

public SynonymsModule withScoreMultiWordsExpressionsAsSingleWords(java.lang.Boolean scoreMultiWordsExpressionsAsSingleWords)

makeCopy

public SynonymsModule makeCopy()

Creates and returns a deep copy of this SynonymsModule.

Overrides:

makeCopy in class QueryExpansionModule

readFrom

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

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

Overrides:

writeTo in class QueryExpansionModule

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SynonymsModule.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SynonymsModule.

Overrides:

toString in class QueryExpansionModule

check

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

Checks this SynonymsModule.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class QueryExpansionModule

Throws:

com.exalead.util.TypedException

accept

public void accept(QueryExpansionModule.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class QueryExpansionModule

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(QueryExpansionModule.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class QueryExpansionModule

Throws:

com.exalead.util.TypedException