com.exalead.mercury.mami.search.v20

Class RelatedTermsSuggest

java.lang.Object

com.exalead.mercury.mami.search.v20.Suggest

com.exalead.mercury.mami.search.v20.BuildableSuggest

com.exalead.mercury.mami.search.v20.SearchBasedSuggest

com.exalead.mercury.mami.search.v20.IndexFieldSuggest

com.exalead.mercury.mami.search.v20.RelatedTermsSuggest

All Implemented Interfaces:

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

public class RelatedTermsSuggest
extends IndexFieldSuggest
implements com.exalead.util.Checkable, java.io.Serializable

Takes the value of the 'keyword' index field.

See Also:

Serialized Form

Nested Class Summary

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

IndexFieldSuggest.Transformer<T>, IndexFieldSuggest.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DICTIONARY_NAME
java.lang.String	dictionaryName

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

DEFAULT_QUERY, indexField, logic, query, searchServerInstance, target

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

suggestBuildConfig, suggestBuildTrigger

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

blackListURL, suggestName, suggestQueryConfig, whiteListURL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(BuildableSuggest.Transformer<T> transformer, T[] t)
void	accept(BuildableSuggest.Visitor visitor)
<T> T	accept(IndexFieldSuggest.Transformer<T> transformer, T[] t)
void	accept(IndexFieldSuggest.Visitor visitor)
<T> T	accept(SearchBasedSuggest.Transformer<T> transformer, T[] t)
void	accept(SearchBasedSuggest.Visitor visitor)
<T> T	accept(Suggest.Transformer<T> transformer, T[] t)
void	accept(Suggest.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this RelatedTermsSuggest.
static RelatedTermsSuggest	fromString(java.lang.String s) String representation of this RelatedTermsSuggest.
java.lang.String	getDictionaryName()
RelatedTermsSuggest	makeCopy() Creates and returns a deep copy of this RelatedTermsSuggest.
static RelatedTermsSuggest	readFrom(java.io.InputStream is) Read this RelatedTermsSuggest from an XML fragment.
void	setDictionaryName(java.lang.String dictionaryName)
java.lang.String	toString() String representation of this RelatedTermsSuggest.
RelatedTermsSuggest	withBlackListURL(java.lang.String blackListURL)
RelatedTermsSuggest	withDictionaryName(java.lang.String dictionaryName)
RelatedTermsSuggest	withIndexField(java.lang.String indexField)
RelatedTermsSuggest	withLogic(java.lang.String logic)
RelatedTermsSuggest	withQuery(java.lang.String query)
RelatedTermsSuggest	withSearchServerInstance(java.lang.String searchServerInstance)
RelatedTermsSuggest	withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)
RelatedTermsSuggest	withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)
RelatedTermsSuggest	withSuggestName(java.lang.String suggestName)
RelatedTermsSuggest	withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)
RelatedTermsSuggest	withTarget(java.lang.String target)
RelatedTermsSuggest	withWhiteListURL(java.lang.String whiteListURL)
void	writeTo(java.io.OutputStream os) Write this RelatedTermsSuggest as an XML fragment

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

getIndexField, getLogic, getQuery, getSearchServerInstance, getTarget, setIndexField, setLogic, setQuery, setSearchServerInstance, setTarget

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

getSuggestBuildConfig, getSuggestBuildTrigger, setSuggestBuildConfig, setSuggestBuildTrigger

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

getBlackListURL, getSuggestName, getSuggestQueryConfig, getWhiteListURL, setBlackListURL, setSuggestName, setSuggestQueryConfig, setWhiteListURL

Methods inherited from class java.lang.Object

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

Field Detail

dictionaryName

public java.lang.String dictionaryName

DEFAULT_DICTIONARY_NAME

public static final java.lang.String DEFAULT_DICTIONARY_NAME

See Also:

Constant Field Values

Constructor Detail

RelatedTermsSuggest

public RelatedTermsSuggest()

RelatedTermsSuggest

public RelatedTermsSuggest(RelatedTermsSuggest o)

Copy constructor

Method Detail

withLogic

public RelatedTermsSuggest withLogic(java.lang.String logic)

Overrides:

withLogic in class IndexFieldSuggest

withTarget

public RelatedTermsSuggest withTarget(java.lang.String target)

Overrides:

withTarget in class IndexFieldSuggest

withIndexField

public RelatedTermsSuggest withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class IndexFieldSuggest

withQuery

public RelatedTermsSuggest withQuery(java.lang.String query)

Overrides:

withQuery in class IndexFieldSuggest

withSearchServerInstance

public RelatedTermsSuggest withSearchServerInstance(java.lang.String searchServerInstance)

Overrides:

withSearchServerInstance in class IndexFieldSuggest

withSuggestBuildTrigger

public RelatedTermsSuggest withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)

Overrides:

withSuggestBuildTrigger in class IndexFieldSuggest

withSuggestBuildConfig

public RelatedTermsSuggest withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)

Overrides:

withSuggestBuildConfig in class IndexFieldSuggest

withSuggestName

public RelatedTermsSuggest withSuggestName(java.lang.String suggestName)

Overrides:

withSuggestName in class IndexFieldSuggest

withWhiteListURL

public RelatedTermsSuggest withWhiteListURL(java.lang.String whiteListURL)

Overrides:

withWhiteListURL in class IndexFieldSuggest

withBlackListURL

public RelatedTermsSuggest withBlackListURL(java.lang.String blackListURL)

Overrides:

withBlackListURL in class IndexFieldSuggest

withSuggestQueryConfig

public RelatedTermsSuggest withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)

Overrides:

withSuggestQueryConfig in class IndexFieldSuggest

setDictionaryName

public void setDictionaryName(java.lang.String dictionaryName)

getDictionaryName

public java.lang.String getDictionaryName()

withDictionaryName

public RelatedTermsSuggest withDictionaryName(java.lang.String dictionaryName)

makeCopy

public RelatedTermsSuggest makeCopy()

Creates and returns a deep copy of this RelatedTermsSuggest.

Overrides:

makeCopy in class IndexFieldSuggest

readFrom

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

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

Overrides:

writeTo in class IndexFieldSuggest

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RelatedTermsSuggest.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RelatedTermsSuggest.

Overrides:

toString in class IndexFieldSuggest

check

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

Checks this RelatedTermsSuggest.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException