com.exalead.mot.qrewrite.v10

Class Synonyms

java.lang.Object

com.exalead.linguistic.v10.Modifiable

com.exalead.mot.qrewrite.v10.Synonyms

All Implemented Interfaces:

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

public class Synonyms
extends Modifiable
implements com.exalead.util.Checkable, java.io.Serializable

The Synonyms feature allows you to define synonym resources

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addStopwordFreeForms
static boolean	DEFAULT_ADD_STOPWORD_FREE_FORMS
static boolean	DEFAULT_EQUIVALENCE_CLASS
static boolean	DEFAULT_MATCH_ON_SEPARATORS
static boolean	DEFAULT_PERMUTATIONS
static java.lang.String	DEFAULT_STOPWORDS_RESOURCE
boolean	equivalenceClass
boolean	matchOnSeparators
boolean	permutations
java.lang.String	stopwordsResource
java.util.List<SynonymSet>	synonymSet

Fields inherited from class com.exalead.linguistic.v10.Modifiable

modifiedAt, modifiedBy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Synonyms.
static Synonyms	fromString(java.lang.String s) String representation of this Synonyms.
java.lang.String	getStopwordsResource() Path to the compiled ontology containing stopwords used at buildtime when generating permutations.
java.util.List<SynonymSet>	getSynonymSet()
boolean	isAddStopwordFreeForms() If true, adds for each synonym an extra form from which stopwords have been removed.
boolean	isEquivalenceClass() A synonym set is defined with a master expression and a set of associated expressions (an expression is defined by many words with a space as separator) originalExpr = {alternativeExpr1, ...., alternativeExprN} When query is parsed we expand originalExpr with {alternativeExpr1, ..., alternativeExprN}. When equivalenceClass boolean is set to true, we also expand : - alternativeExpr1 by originalExpr, alternativeExpr2, ..., alternativeExprN - alternativeExpr2 by originalExpr, alternativeExpr1, alternativeExpr3, ..., alternativeExprN - ... - alternativeExprN by originalExpr, alternativeExpr1, ..., alternativeExprN-1
boolean	isMatchOnSeparators() If false, synonym matching is punctuation-insensitive.
boolean	isPermutations() If true, adds for each synonym some extra forms made of words permutations after removing stopwords.
Synonyms	makeCopy() Creates and returns a deep copy of this Synonyms.
static Synonyms	readFrom(java.io.InputStream is) Read this Synonyms from an XML fragment.
void	setAddStopwordFreeForms(boolean addStopwordFreeForms) If true, adds for each synonym an extra form from which stopwords have been removed.
void	setEquivalenceClass(boolean equivalenceClass) A synonym set is defined with a master expression and a set of associated expressions (an expression is defined by many words with a space as separator) originalExpr = {alternativeExpr1, ...., alternativeExprN} When query is parsed we expand originalExpr with {alternativeExpr1, ..., alternativeExprN}. When equivalenceClass boolean is set to true, we also expand : - alternativeExpr1 by originalExpr, alternativeExpr2, ..., alternativeExprN - alternativeExpr2 by originalExpr, alternativeExpr1, alternativeExpr3, ..., alternativeExprN - ... - alternativeExprN by originalExpr, alternativeExpr1, ..., alternativeExprN-1
void	setMatchOnSeparators(boolean matchOnSeparators) If false, synonym matching is punctuation-insensitive.
void	setPermutations(boolean permutations) If true, adds for each synonym some extra forms made of words permutations after removing stopwords.
void	setStopwordsResource(java.lang.String stopwordsResource) Path to the compiled ontology containing stopwords used at buildtime when generating permutations.
java.lang.String	toString() String representation of this Synonyms.
Synonyms	withAddStopwordFreeForms(boolean addStopwordFreeForms)
Synonyms	withAddStopwordFreeForms(java.lang.Boolean addStopwordFreeForms)
Synonyms	withEquivalenceClass(boolean equivalenceClass)
Synonyms	withEquivalenceClass(java.lang.Boolean equivalenceClass)
Synonyms	withMatchOnSeparators(boolean matchOnSeparators)
Synonyms	withMatchOnSeparators(java.lang.Boolean matchOnSeparators)
Synonyms	withModifiedAt(java.lang.Long modifiedAt)
Synonyms	withModifiedBy(java.lang.String modifiedBy)
Synonyms	withPermutations(boolean permutations)
Synonyms	withPermutations(java.lang.Boolean permutations)
Synonyms	withStopwordsResource(java.lang.String stopwordsResource)
Synonyms	withSynonymSet(java.util.Collection<SynonymSet> __values)
Synonyms	withSynonymSet(SynonymSet... __values)
void	writeTo(java.io.OutputStream os) Write this Synonyms as an XML fragment

Methods inherited from class com.exalead.linguistic.v10.Modifiable

getModifiedAt, getModifiedBy, setModifiedAt, setModifiedBy

Methods inherited from class java.lang.Object

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

Field Detail

synonymSet

public java.util.List<SynonymSet> synonymSet

equivalenceClass

public boolean equivalenceClass

DEFAULT_EQUIVALENCE_CLASS

public static final boolean DEFAULT_EQUIVALENCE_CLASS

See Also:

Constant Field Values

matchOnSeparators

public boolean matchOnSeparators

DEFAULT_MATCH_ON_SEPARATORS

public static final boolean DEFAULT_MATCH_ON_SEPARATORS

See Also:

Constant Field Values

stopwordsResource

public java.lang.String stopwordsResource

DEFAULT_STOPWORDS_RESOURCE

public static final java.lang.String DEFAULT_STOPWORDS_RESOURCE

See Also:

Constant Field Values

permutations

public boolean permutations

DEFAULT_PERMUTATIONS

public static final boolean DEFAULT_PERMUTATIONS

See Also:

Constant Field Values

addStopwordFreeForms

public boolean addStopwordFreeForms

DEFAULT_ADD_STOPWORD_FREE_FORMS

public static final boolean DEFAULT_ADD_STOPWORD_FREE_FORMS

See Also:

Constant Field Values

Constructor Detail

Synonyms

public Synonyms()

Synonyms

public Synonyms(Synonyms o)

Copy constructor

Method Detail

withModifiedBy

public Synonyms withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class Modifiable

withModifiedAt

public Synonyms withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class Modifiable

getSynonymSet

public java.util.List<SynonymSet> getSynonymSet()

withSynonymSet

public Synonyms withSynonymSet(SynonymSet... __values)

withSynonymSet

public Synonyms withSynonymSet(java.util.Collection<SynonymSet> __values)

setEquivalenceClass

public void setEquivalenceClass(boolean equivalenceClass)

A synonym set is defined with a master expression and a set of
associated expressions (an expression is defined by many words with a space as separator)
originalExpr = {alternativeExpr1, ...., alternativeExprN}
When query is parsed we expand originalExpr with {alternativeExpr1, ..., alternativeExprN}.
When equivalenceClass boolean is set to true, we also expand :
- alternativeExpr1 by originalExpr, alternativeExpr2, ..., alternativeExprN
- alternativeExpr2 by originalExpr, alternativeExpr1, alternativeExpr3, ..., alternativeExprN
- ...
- alternativeExprN by originalExpr, alternativeExpr1, ..., alternativeExprN-1

isEquivalenceClass

public boolean isEquivalenceClass()

A synonym set is defined with a master expression and a set of
associated expressions (an expression is defined by many words with a space as separator)
originalExpr = {alternativeExpr1, ...., alternativeExprN}
When query is parsed we expand originalExpr with {alternativeExpr1, ..., alternativeExprN}.
When equivalenceClass boolean is set to true, we also expand :
- alternativeExpr1 by originalExpr, alternativeExpr2, ..., alternativeExprN
- alternativeExpr2 by originalExpr, alternativeExpr1, alternativeExpr3, ..., alternativeExprN
- ...
- alternativeExprN by originalExpr, alternativeExpr1, ..., alternativeExprN-1

withEquivalenceClass

public Synonyms withEquivalenceClass(boolean equivalenceClass)

withEquivalenceClass

public Synonyms withEquivalenceClass(java.lang.Boolean equivalenceClass)

setMatchOnSeparators

public void setMatchOnSeparators(boolean matchOnSeparators)

If false, synonym matching is punctuation-insensitive.

isMatchOnSeparators

public boolean isMatchOnSeparators()

If false, synonym matching is punctuation-insensitive.

withMatchOnSeparators

public Synonyms withMatchOnSeparators(boolean matchOnSeparators)

withMatchOnSeparators

public Synonyms withMatchOnSeparators(java.lang.Boolean matchOnSeparators)

setStopwordsResource

public void setStopwordsResource(java.lang.String stopwordsResource)

Path to the compiled ontology containing stopwords used at buildtime when generating permutations.

getStopwordsResource

public java.lang.String getStopwordsResource()

Path to the compiled ontology containing stopwords used at buildtime when generating permutations.

withStopwordsResource

public Synonyms withStopwordsResource(java.lang.String stopwordsResource)

setPermutations

public void setPermutations(boolean permutations)

If true, adds for each synonym some extra forms made of words permutations after removing stopwords.

isPermutations

public boolean isPermutations()

If true, adds for each synonym some extra forms made of words permutations after removing stopwords.

withPermutations

public Synonyms withPermutations(boolean permutations)

withPermutations

public Synonyms withPermutations(java.lang.Boolean permutations)

setAddStopwordFreeForms

public void setAddStopwordFreeForms(boolean addStopwordFreeForms)

If true, adds for each synonym an extra form from which stopwords have been removed.

isAddStopwordFreeForms

public boolean isAddStopwordFreeForms()

If true, adds for each synonym an extra form from which stopwords have been removed.

withAddStopwordFreeForms

public Synonyms withAddStopwordFreeForms(boolean addStopwordFreeForms)

withAddStopwordFreeForms

public Synonyms withAddStopwordFreeForms(java.lang.Boolean addStopwordFreeForms)

makeCopy

public Synonyms makeCopy()

Creates and returns a deep copy of this Synonyms.

Overrides:

makeCopy in class Modifiable

readFrom

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

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

Overrides:

writeTo in class Modifiable

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Synonyms.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Synonyms.

Overrides:

toString in class Modifiable

check

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

Checks this Synonyms.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Modifiable

Throws:

com.exalead.util.TypedException