com.exalead.mot.qrewrite.v10

Class Synonym

java.lang.Object

com.exalead.linguistic.v10.Modifiable

com.exalead.mot.qrewrite.v10.Synonym

All Implemented Interfaces:

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

public class Synonym
extends Modifiable
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	Synonym.Level

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	alternativeExpr
byte	customLevel
static java.lang.String	DEFAULT_LEVEL
int	distance
java.lang.String	lang
java.lang.String	level

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

modifiedAt, modifiedBy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Synonym.
static Synonym	fromString(java.lang.String s) String representation of this Synonym.
java.lang.String	getAlternativeExpr() Synonym string: can be a multi word expression (separated by space only)
byte	getCustomLevel() (only when level == "custom") when level = "custom", this customLevel is used
int	getDistance() distance applied to this synonym
java.lang.String	getLang() if not null, override language of SynonymSet
java.lang.String	getLevel() display level
Synonym.Level	getLevelAsEnum() display level
static boolean	isA(java.lang.String str, Synonym.Level item)
static boolean	isOneOf(java.lang.String str, Synonym.Level... items)
Synonym	makeCopy() Creates and returns a deep copy of this Synonym.
static Synonym	readFrom(java.io.InputStream is) Read this Synonym from an XML fragment.
void	setAlternativeExpr(java.lang.String alternativeExpr) Synonym string: can be a multi word expression (separated by space only)
void	setCustomLevel(byte customLevel) (only when level == "custom") when level = "custom", this customLevel is used
void	setDistance(int distance) distance applied to this synonym
void	setLang(java.lang.String lang) if not null, override language of SynonymSet
void	setLevel(java.lang.String level) display level
void	setLevel(Synonym.Level item) display level
java.lang.String	toString() String representation of this Synonym.
Synonym	withAlternativeExpr(java.lang.String alternativeExpr)
Synonym	withCustomLevel(byte customLevel)
Synonym	withCustomLevel(java.lang.Byte customLevel)
Synonym	withDistance(int distance)
Synonym	withDistance(java.lang.Integer distance)
Synonym	withLang(java.lang.String lang)
Synonym	withLevel(java.lang.String level)
Synonym	withModifiedAt(java.lang.Long modifiedAt)
Synonym	withModifiedBy(java.lang.String modifiedBy)
void	writeTo(java.io.OutputStream os) Write this Synonym 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

alternativeExpr

public java.lang.String alternativeExpr

level

public java.lang.String level

DEFAULT_LEVEL

public static final java.lang.String DEFAULT_LEVEL

See Also:

Constant Field Values

customLevel

public byte customLevel

distance

public int distance

lang

public java.lang.String lang

Constructor Detail

Synonym

public Synonym()

Synonym

public Synonym(Synonym o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setLevel

public void setLevel(Synonym.Level item)

display level

getLevelAsEnum

public Synonym.Level getLevelAsEnum()

display level

withModifiedBy

public Synonym withModifiedBy(java.lang.String modifiedBy)

Overrides:

withModifiedBy in class Modifiable

withModifiedAt

public Synonym withModifiedAt(java.lang.Long modifiedAt)

Overrides:

withModifiedAt in class Modifiable

setAlternativeExpr

public void setAlternativeExpr(java.lang.String alternativeExpr)

Synonym string: can be a multi word expression (separated by space only)

getAlternativeExpr

public java.lang.String getAlternativeExpr()

Synonym string: can be a multi word expression (separated by space only)

withAlternativeExpr

public Synonym withAlternativeExpr(java.lang.String alternativeExpr)

setLevel

public void setLevel(java.lang.String level)

display level

getLevel

public java.lang.String getLevel()

display level

withLevel

public Synonym withLevel(java.lang.String level)

setCustomLevel

public void setCustomLevel(byte customLevel)

(only when level == "custom")
when level = "custom", this customLevel is used

getCustomLevel

public byte getCustomLevel()

(only when level == "custom")
when level = "custom", this customLevel is used

withCustomLevel

public Synonym withCustomLevel(byte customLevel)

withCustomLevel

public Synonym withCustomLevel(java.lang.Byte customLevel)

setDistance

public void setDistance(int distance)

distance applied to this synonym

getDistance

public int getDistance()

distance applied to this synonym

withDistance

public Synonym withDistance(int distance)

withDistance

public Synonym withDistance(java.lang.Integer distance)

setLang

public void setLang(java.lang.String lang)

if not null, override language of SynonymSet

getLang

public java.lang.String getLang()

if not null, override language of SynonymSet

withLang

public Synonym withLang(java.lang.String lang)

makeCopy

public Synonym makeCopy()

Creates and returns a deep copy of this Synonym.

Overrides:

makeCopy in class Modifiable

readFrom

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

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

Overrides:

writeTo in class Modifiable

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Synonym.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Synonym.

Overrides:

toString in class Modifiable

check

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

Checks this Synonym.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Modifiable

Throws:

com.exalead.util.TypedException