com.exalead.mot.qrewrite.v10

Class SynonymSet

java.lang.Object

com.exalead.linguistic.v10.Modifiable

com.exalead.mot.qrewrite.v10.SynonymSet

All Implemented Interfaces:

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

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

A set of synonym terms.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SynonymSet.EquivalenceClass
static class	SynonymSet.Level

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LEVEL
java.lang.String	equivalenceClass
java.lang.String	lang
java.lang.String	level
java.lang.String	originalExpr
java.util.List<Synonym>	synonym

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

modifiedAt, modifiedBy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SynonymSet.
static SynonymSet	fromString(java.lang.String s) String representation of this SynonymSet.
java.lang.String	getEquivalenceClass() override equivalenceClass boolean if null or different from true/false, keep Synonyms.equivalenceClass value
SynonymSet.EquivalenceClass	getEquivalenceClassAsEnum() override equivalenceClass boolean if null or different from true/false, keep Synonyms.equivalenceClass value
java.lang.String	getLang() Only match the original expression in this language.
java.lang.String	getLevel() Term level of these expressions.
SynonymSet.Level	getLevelAsEnum() Term level of these expressions.
java.lang.String	getOriginalExpr() String to match in user query
java.util.List<Synonym>	getSynonym() The list of synonyms of the original expression.
static boolean	isA(java.lang.String str, SynonymSet.EquivalenceClass item)
static boolean	isA(java.lang.String str, SynonymSet.Level item)
static boolean	isOneOf(java.lang.String str, SynonymSet.EquivalenceClass... items)
static boolean	isOneOf(java.lang.String str, SynonymSet.Level... items)
SynonymSet	makeCopy() Creates and returns a deep copy of this SynonymSet.
static SynonymSet	readFrom(java.io.InputStream is) Read this SynonymSet from an XML fragment.
void	setEquivalenceClass(java.lang.String equivalenceClass) override equivalenceClass boolean if null or different from true/false, keep Synonyms.equivalenceClass value
void	setEquivalenceClass(SynonymSet.EquivalenceClass item) override equivalenceClass boolean if null or different from true/false, keep Synonyms.equivalenceClass value
void	setLang(java.lang.String lang) Only match the original expression in this language.
void	setLevel(java.lang.String level) Term level of these expressions.
void	setLevel(SynonymSet.Level item) Term level of these expressions.
void	setOriginalExpr(java.lang.String originalExpr) String to match in user query
java.lang.String	toString() String representation of this SynonymSet.
SynonymSet	withEquivalenceClass(java.lang.String equivalenceClass)
SynonymSet	withLang(java.lang.String lang)
SynonymSet	withLevel(java.lang.String level)
SynonymSet	withModifiedAt(java.lang.Long modifiedAt)
SynonymSet	withModifiedBy(java.lang.String modifiedBy)
SynonymSet	withOriginalExpr(java.lang.String originalExpr)
SynonymSet	withSynonym(java.util.Collection<Synonym> __values)
SynonymSet	withSynonym(Synonym... __values) The list of synonyms of the original expression.
void	writeTo(java.io.OutputStream os) Write this SynonymSet 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

synonym

public java.util.List<Synonym> synonym

originalExpr

public java.lang.String originalExpr

level

public java.lang.String level

DEFAULT_LEVEL

public static final java.lang.String DEFAULT_LEVEL

See Also:

Constant Field Values

lang

public java.lang.String lang

equivalenceClass

public java.lang.String equivalenceClass

Constructor Detail

SynonymSet

public SynonymSet()

SynonymSet

public SynonymSet(SynonymSet o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          SynonymSet.Level item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              SynonymSet.Level... items)

setLevel

public void setLevel(SynonymSet.Level item)

Term level of these expressions.

getLevelAsEnum

public SynonymSet.Level getLevelAsEnum()

Term level of these expressions.

isA

public static boolean isA(java.lang.String str,
                          SynonymSet.EquivalenceClass item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              SynonymSet.EquivalenceClass... items)

setEquivalenceClass

public void setEquivalenceClass(SynonymSet.EquivalenceClass item)

override equivalenceClass boolean
if null or different from true/false, keep Synonyms.equivalenceClass value

getEquivalenceClassAsEnum

public SynonymSet.EquivalenceClass getEquivalenceClassAsEnum()

override equivalenceClass boolean
if null or different from true/false, keep Synonyms.equivalenceClass value

withModifiedBy

public SynonymSet withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class Modifiable

withModifiedAt

public SynonymSet withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class Modifiable

getSynonym

public java.util.List<Synonym> getSynonym()

The list of synonyms of the original expression.

withSynonym

public SynonymSet withSynonym(Synonym... __values)

The list of synonyms of the original expression.

withSynonym

public SynonymSet withSynonym(java.util.Collection<Synonym> __values)

setOriginalExpr

public void setOriginalExpr(java.lang.String originalExpr)

String to match in user query

getOriginalExpr

public java.lang.String getOriginalExpr()

String to match in user query

withOriginalExpr

public SynonymSet withOriginalExpr(java.lang.String originalExpr)

setLevel

public void setLevel(java.lang.String level)

Term level of these expressions.

getLevel

public java.lang.String getLevel()

Term level of these expressions.

withLevel

public SynonymSet withLevel(java.lang.String level)

setLang

public void setLang(java.lang.String lang)

Only match the original expression in this language.

getLang

public java.lang.String getLang()

Only match the original expression in this language.

withLang

public SynonymSet withLang(java.lang.String lang)

setEquivalenceClass

public void setEquivalenceClass(java.lang.String equivalenceClass)

override equivalenceClass boolean
if null or different from true/false, keep Synonyms.equivalenceClass value

getEquivalenceClass

public java.lang.String getEquivalenceClass()

override equivalenceClass boolean
if null or different from true/false, keep Synonyms.equivalenceClass value

withEquivalenceClass

public SynonymSet withEquivalenceClass(java.lang.String equivalenceClass)

makeCopy

public SynonymSet makeCopy()

Creates and returns a deep copy of this SynonymSet.

Overrides:

makeCopy in class Modifiable

readFrom

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

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

Overrides:

writeTo in class Modifiable

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SynonymSet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SynonymSet.

Overrides:

toString in class Modifiable

check

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

Checks this SynonymSet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Modifiable

Throws:

com.exalead.util.TypedException