com.exalead.mercury.mami.search.v20

Class Suggest

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BuildableSuggest, StaticResourceSuggest, StaticXMLSuggest

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

Suggest Base Class

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	blackListURL
java.lang.String	suggestName
SuggestQueryConfig	suggestQueryConfig
java.lang.String	whiteListURL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(Suggest.Transformer<T> transformer, T[] t)
abstract void	accept(Suggest.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this Suggest.
static Suggest	fromString(java.lang.String s) String representation of this Suggest.
java.lang.String	getBlackListURL() URL to a suggest-block list resource
java.lang.String	getSuggestName() The mandatory suggest name.
SuggestQueryConfig	getSuggestQueryConfig()
java.lang.String	getWhiteListURL() URL to a suggest-allow list resource
Suggest	makeCopy()
static Suggest	readFrom(java.io.InputStream is) Read this Suggest from an XML fragment.
void	setBlackListURL(java.lang.String blackListURL) URL to a suggest-block list resource
void	setSuggestName(java.lang.String suggestName) The mandatory suggest name.
void	setSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)
void	setWhiteListURL(java.lang.String whiteListURL) URL to a suggest-allow list resource
java.lang.String	toString() String representation of this Suggest.
Suggest	withBlackListURL(java.lang.String blackListURL)
Suggest	withSuggestName(java.lang.String suggestName)
Suggest	withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)
Suggest	withWhiteListURL(java.lang.String whiteListURL)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

suggestName

public java.lang.String suggestName

whiteListURL

public java.lang.String whiteListURL

blackListURL

public java.lang.String blackListURL

suggestQueryConfig

public SuggestQueryConfig suggestQueryConfig

Constructor Detail

Suggest

public Suggest()

Suggest

public Suggest(Suggest o)

Copy constructor

Method Detail

setSuggestName

public void setSuggestName(java.lang.String suggestName)

The mandatory suggest name. Must match [A-z0-9_]+

getSuggestName

public java.lang.String getSuggestName()

The mandatory suggest name. Must match [A-z0-9_]+

withSuggestName

public Suggest withSuggestName(java.lang.String suggestName)

setWhiteListURL

public void setWhiteListURL(java.lang.String whiteListURL)

URL to a suggest-allow list resource

getWhiteListURL

public java.lang.String getWhiteListURL()

URL to a suggest-allow list resource

withWhiteListURL

public Suggest withWhiteListURL(java.lang.String whiteListURL)

setBlackListURL

public void setBlackListURL(java.lang.String blackListURL)

URL to a suggest-block list resource

getBlackListURL

public java.lang.String getBlackListURL()

URL to a suggest-block list resource

withBlackListURL

public Suggest withBlackListURL(java.lang.String blackListURL)

setSuggestQueryConfig

public void setSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)

getSuggestQueryConfig

public SuggestQueryConfig getSuggestQueryConfig()

withSuggestQueryConfig

public Suggest withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)

makeCopy

public Suggest makeCopy()

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Suggest.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Suggest.

Overrides:

toString in class java.lang.Object

check

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

Checks this Suggest.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException