Package com.algolia.search.models.synonyms

Class Synonym

java.lang.Object

com.algolia.search.models.synonyms.Synonym

All Implemented Interfaces:

Serializable

public class Synonym
extends Object
implements Serializable

Synonyms tell the engine which words and expressions should be considered equal - for example, pants ⇔ trousers or mad ⇔ angry. A search for “trousers” will find “pants”, and “pants” will find “trousers”.

* @see Algolia.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Synonym()

Method Summary

Modifier and Type	Method	Description
static Synonym	createAltCorrection1(String objectID, String word, List<String> corrections)
static Synonym	createAltCorrection2(String objectID, String word, List<String> corrections)
static Synonym	createOneWaySynonym(String objectID, String input, List<String> synonyms)
static Synonym	createPlaceHolder(String objectID, String placeholder, List<String> replacements)
static Synonym	createSynonym(String objectID, List<String> synonyms)
List<String>	getCorrections()
String	getInput()
String	getObjectID()
String	getPlaceholder()
List<String>	getReplacements()
List<String>	getSynonyms()
String	getType()
String	getWord()
Synonym	setCorrections(List<String> corrections)
Synonym	setInput(String input)
Synonym	setObjectID(String objectID)
Synonym	setPlaceholder(String placeholder)
Synonym	setReplacements(List<String> replacements)
Synonym	setSynonyms(List<String> synonyms)
Synonym	setType(String type)
Synonym	setWord(String word)

Methods inherited from class java.lang.Object

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

Constructor Detail

Synonym

public Synonym()

Method Detail

createSynonym

public static Synonym createSynonym(String objectID,
                                    List<String> synonyms)

createOneWaySynonym

public static Synonym createOneWaySynonym(String objectID,
                                          String input,
                                          List<String> synonyms)

createPlaceHolder

public static Synonym createPlaceHolder(String objectID,
                                        String placeholder,
                                        List<String> replacements)

createAltCorrection1

public static Synonym createAltCorrection1(String objectID,
                                           String word,
                                           List<String> corrections)

createAltCorrection2

public static Synonym createAltCorrection2(String objectID,
                                           String word,
                                           List<String> corrections)

getObjectID

public String getObjectID()

setObjectID

public Synonym setObjectID(String objectID)

getType

public String getType()

setType

public Synonym setType(String type)

getSynonyms

public List<String> getSynonyms()

setSynonyms

public Synonym setSynonyms(List<String> synonyms)

getInput

public String getInput()

setInput

public Synonym setInput(String input)

getWord

public String getWord()

setWord

public Synonym setWord(String word)

getCorrections

public List<String> getCorrections()

setCorrections

public Synonym setCorrections(List<String> corrections)

getPlaceholder

public String getPlaceholder()

setPlaceholder

public Synonym setPlaceholder(String placeholder)

getReplacements

public List<String> getReplacements()

setReplacements

public Synonym setReplacements(List<String> replacements)