com.exalead.mercury.mami.search.v20

Class BuildableSuggest

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

QueryReportingSuggest, SearchBasedSuggest

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

Suggest based class for buildable suggests.
A buildable suggest is a suggest than can be built programmatically.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
SuggestBuildConfig	suggestBuildConfig
SuggestBuildTrigger	suggestBuildTrigger

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

blackListURL, suggestName, suggestQueryConfig, whiteListURL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(BuildableSuggest.Transformer<T> transformer, T[] t)
abstract void	accept(BuildableSuggest.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this BuildableSuggest.
static BuildableSuggest	fromString(java.lang.String s) String representation of this BuildableSuggest.
SuggestBuildConfig	getSuggestBuildConfig() Build options
SuggestBuildTrigger	getSuggestBuildTrigger() Optional build trigger
BuildableSuggest	makeCopy()
static BuildableSuggest	readFrom(java.io.InputStream is) Read this BuildableSuggest from an XML fragment.
void	setSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig) Build options
void	setSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger) Optional build trigger
java.lang.String	toString() String representation of this BuildableSuggest.
BuildableSuggest	withBlackListURL(java.lang.String blackListURL)
BuildableSuggest	withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)
BuildableSuggest	withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)
BuildableSuggest	withSuggestName(java.lang.String suggestName)
BuildableSuggest	withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)
BuildableSuggest	withWhiteListURL(java.lang.String whiteListURL)
void	writeTo(java.io.OutputStream os)

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

suggestBuildTrigger

public SuggestBuildTrigger suggestBuildTrigger

suggestBuildConfig

public SuggestBuildConfig suggestBuildConfig

Constructor Detail

BuildableSuggest

public BuildableSuggest()

BuildableSuggest

public BuildableSuggest(BuildableSuggest o)

Copy constructor

Method Detail

withSuggestName

public BuildableSuggest withSuggestName(java.lang.String suggestName)

Overrides:

withSuggestName in class Suggest

withWhiteListURL

public BuildableSuggest withWhiteListURL(java.lang.String whiteListURL)

Overrides:

withWhiteListURL in class Suggest

withBlackListURL

public BuildableSuggest withBlackListURL(java.lang.String blackListURL)

Overrides:

withBlackListURL in class Suggest

withSuggestQueryConfig

public BuildableSuggest withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)

Overrides:

withSuggestQueryConfig in class Suggest

setSuggestBuildTrigger

public void setSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)

Optional build trigger

getSuggestBuildTrigger

public SuggestBuildTrigger getSuggestBuildTrigger()

Optional build trigger

withSuggestBuildTrigger

public BuildableSuggest withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)

setSuggestBuildConfig

public void setSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)

Build options

getSuggestBuildConfig

public SuggestBuildConfig getSuggestBuildConfig()

Build options

withSuggestBuildConfig

public BuildableSuggest withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)

makeCopy

public BuildableSuggest makeCopy()

Overrides:

makeCopy in class Suggest

readFrom

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

Read this BuildableSuggest 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 Suggest

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this BuildableSuggest.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this BuildableSuggest.

Overrides:

toString in class Suggest

check

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

Checks this BuildableSuggest.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Suggest

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException