com.exalead.mercury.mami.search.v20

Class SearchBasedSuggest

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CategorySuggest, IndexFieldSuggest

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

Base class for suggests retrieving their data through a search client

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_QUERY
java.lang.String	indexField
java.lang.String	logic
java.lang.String	query
java.lang.String	searchServerInstance
java.lang.String	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
SearchBasedSuggest()
SearchBasedSuggest(SearchBasedSuggest o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(SearchBasedSuggest.Transformer<T> transformer, T[] t)
abstract void	accept(SearchBasedSuggest.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SearchBasedSuggest.
static SearchBasedSuggest	fromString(java.lang.String s) String representation of this SearchBasedSuggest.
java.lang.String	getIndexField() The index field to retrieve
java.lang.String	getLogic() The search logic to use
java.lang.String	getQuery() The query: may be used as a filter for the exported index data
java.lang.String	getSearchServerInstance() The search server instance to target
java.lang.String	getTarget() The search target to use
SearchBasedSuggest	makeCopy()
static SearchBasedSuggest	readFrom(java.io.InputStream is) Read this SearchBasedSuggest from an XML fragment.
void	setIndexField(java.lang.String indexField) The index field to retrieve
void	setLogic(java.lang.String logic) The search logic to use
void	setQuery(java.lang.String query) The query: may be used as a filter for the exported index data
void	setSearchServerInstance(java.lang.String searchServerInstance) The search server instance to target
void	setTarget(java.lang.String target) The search target to use
java.lang.String	toString() String representation of this SearchBasedSuggest.
SearchBasedSuggest	withBlackListURL(java.lang.String blackListURL)
SearchBasedSuggest	withIndexField(java.lang.String indexField)
SearchBasedSuggest	withLogic(java.lang.String logic)
SearchBasedSuggest	withQuery(java.lang.String query)
SearchBasedSuggest	withSearchServerInstance(java.lang.String searchServerInstance)
SearchBasedSuggest	withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)
SearchBasedSuggest	withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)
SearchBasedSuggest	withSuggestName(java.lang.String suggestName)
SearchBasedSuggest	withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)
SearchBasedSuggest	withTarget(java.lang.String target)
SearchBasedSuggest	withWhiteListURL(java.lang.String whiteListURL)
void	writeTo(java.io.OutputStream os)

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

accept, accept, getSuggestBuildConfig, getSuggestBuildTrigger, setSuggestBuildConfig, setSuggestBuildTrigger

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

accept, accept, 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

logic

public java.lang.String logic

target

public java.lang.String target

indexField

public java.lang.String indexField

query

public java.lang.String query

DEFAULT_QUERY

public static final java.lang.String DEFAULT_QUERY

See Also:

Constant Field Values

searchServerInstance

public java.lang.String searchServerInstance

Constructor Detail

SearchBasedSuggest

public SearchBasedSuggest()

SearchBasedSuggest

public SearchBasedSuggest(SearchBasedSuggest o)

Copy constructor

Method Detail

withSuggestBuildTrigger

public SearchBasedSuggest withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)

Overrides:

withSuggestBuildTrigger in class BuildableSuggest

withSuggestBuildConfig

public SearchBasedSuggest withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)

Overrides:

withSuggestBuildConfig in class BuildableSuggest

withSuggestName

public SearchBasedSuggest withSuggestName(java.lang.String suggestName)

Overrides:

withSuggestName in class BuildableSuggest

withWhiteListURL

public SearchBasedSuggest withWhiteListURL(java.lang.String whiteListURL)

Overrides:

withWhiteListURL in class BuildableSuggest

withBlackListURL

public SearchBasedSuggest withBlackListURL(java.lang.String blackListURL)

Overrides:

withBlackListURL in class BuildableSuggest

withSuggestQueryConfig

public SearchBasedSuggest withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)

Overrides:

withSuggestQueryConfig in class BuildableSuggest

setLogic

public void setLogic(java.lang.String logic)

The search logic to use

getLogic

public java.lang.String getLogic()

The search logic to use

withLogic

public SearchBasedSuggest withLogic(java.lang.String logic)

setTarget

public void setTarget(java.lang.String target)

The search target to use

getTarget

public java.lang.String getTarget()

The search target to use

withTarget

public SearchBasedSuggest withTarget(java.lang.String target)

setIndexField

public void setIndexField(java.lang.String indexField)

The index field to retrieve

getIndexField

public java.lang.String getIndexField()

The index field to retrieve

withIndexField

public SearchBasedSuggest withIndexField(java.lang.String indexField)

setQuery

public void setQuery(java.lang.String query)

The query: may be used as a filter for the exported index data

getQuery

public java.lang.String getQuery()

The query: may be used as a filter for the exported index data

withQuery

public SearchBasedSuggest withQuery(java.lang.String query)

setSearchServerInstance

public void setSearchServerInstance(java.lang.String searchServerInstance)

The search server instance to target

getSearchServerInstance

public java.lang.String getSearchServerInstance()

The search server instance to target

withSearchServerInstance

public SearchBasedSuggest withSearchServerInstance(java.lang.String searchServerInstance)

makeCopy

public SearchBasedSuggest makeCopy()

Overrides:

makeCopy in class BuildableSuggest

readFrom

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

Read this SearchBasedSuggest 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

Overrides:

writeTo in class BuildableSuggest

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SearchBasedSuggest.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SearchBasedSuggest.

Overrides:

toString in class BuildableSuggest

check

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

Checks this SearchBasedSuggest.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BuildableSuggest

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException