com.exalead.mercury.mami.search.v20

Class IndexFieldSuggest

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CSVIndexFieldSuggest, DynamicFieldSuggest, RelatedTermsSuggest

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

Takes the value of an index field to build a suggest.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IndexFieldSuggest.Transformer<T>
static interface	IndexFieldSuggest.Visitor

Field Summary

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
IndexFieldSuggest()
IndexFieldSuggest(IndexFieldSuggest 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 IndexFieldSuggest.
static IndexFieldSuggest	fromString(java.lang.String s) String representation of this IndexFieldSuggest.
IndexFieldSuggest	makeCopy() Creates and returns a deep copy of this IndexFieldSuggest.
static IndexFieldSuggest	readFrom(java.io.InputStream is) Read this IndexFieldSuggest from an XML fragment.
java.lang.String	toString() String representation of this IndexFieldSuggest.
IndexFieldSuggest	withBlackListURL(java.lang.String blackListURL)
IndexFieldSuggest	withIndexField(java.lang.String indexField)
IndexFieldSuggest	withLogic(java.lang.String logic)
IndexFieldSuggest	withQuery(java.lang.String query)
IndexFieldSuggest	withSearchServerInstance(java.lang.String searchServerInstance)
IndexFieldSuggest	withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)
IndexFieldSuggest	withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)
IndexFieldSuggest	withSuggestName(java.lang.String suggestName)
IndexFieldSuggest	withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)
IndexFieldSuggest	withTarget(java.lang.String target)
IndexFieldSuggest	withWhiteListURL(java.lang.String whiteListURL)
void	writeTo(java.io.OutputStream os) Write this IndexFieldSuggest 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

Constructor Detail

IndexFieldSuggest

public IndexFieldSuggest()

IndexFieldSuggest

public IndexFieldSuggest(IndexFieldSuggest o)

Copy constructor

Method Detail

withLogic

public IndexFieldSuggest withLogic(java.lang.String logic)

Overrides:

withLogic in class SearchBasedSuggest

withTarget

public IndexFieldSuggest withTarget(java.lang.String target)

Overrides:

withTarget in class SearchBasedSuggest

withIndexField

public IndexFieldSuggest withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class SearchBasedSuggest

withQuery

public IndexFieldSuggest withQuery(java.lang.String query)

Overrides:

withQuery in class SearchBasedSuggest

withSearchServerInstance

public IndexFieldSuggest withSearchServerInstance(java.lang.String searchServerInstance)

Overrides:

withSearchServerInstance in class SearchBasedSuggest

withSuggestBuildTrigger

public IndexFieldSuggest withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)

Overrides:

withSuggestBuildTrigger in class SearchBasedSuggest

withSuggestBuildConfig

public IndexFieldSuggest withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)

Overrides:

withSuggestBuildConfig in class SearchBasedSuggest

withSuggestName

public IndexFieldSuggest withSuggestName(java.lang.String suggestName)

Overrides:

withSuggestName in class SearchBasedSuggest

withWhiteListURL

public IndexFieldSuggest withWhiteListURL(java.lang.String whiteListURL)

Overrides:

withWhiteListURL in class SearchBasedSuggest

withBlackListURL

public IndexFieldSuggest withBlackListURL(java.lang.String blackListURL)

Overrides:

withBlackListURL in class SearchBasedSuggest

withSuggestQueryConfig

public IndexFieldSuggest withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)

Overrides:

withSuggestQueryConfig in class SearchBasedSuggest

makeCopy

public IndexFieldSuggest makeCopy()

Creates and returns a deep copy of this IndexFieldSuggest.

Overrides:

makeCopy in class SearchBasedSuggest

readFrom

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

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

Overrides:

writeTo in class SearchBasedSuggest

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this IndexFieldSuggest.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IndexFieldSuggest.

Overrides:

toString in class SearchBasedSuggest

check

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

Checks this IndexFieldSuggest.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SearchBasedSuggest

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SearchBasedSuggest

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class BuildableSuggest

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class Suggest

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SearchBasedSuggest

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class BuildableSuggest

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class Suggest

Throws:

com.exalead.util.TypedException