com.exalead.mercury.mami.search.v20

Class QueryReportingSuggest

java.lang.Object

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

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

com.exalead.mercury.mami.search.v20.QueryReportingSuggest

All Implemented Interfaces:

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

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

Takes the user queries stored for query reporting to build a suggest automatically.

See Also:

Serialized Form

Nested Class Summary

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

BuildableSuggest.Transformer<T>, BuildableSuggest.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	applicationId
static boolean	DEFAULT_DISCARD_COMPLEX_QUERY
boolean	discardComplexQuery

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
QueryReportingSuggest()
QueryReportingSuggest(QueryReportingSuggest 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(Suggest.Transformer<T> transformer, T[] t)
void	accept(Suggest.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this QueryReportingSuggest.
static QueryReportingSuggest	fromString(java.lang.String s) String representation of this QueryReportingSuggest.
java.lang.String	getApplicationId() Retrieves logs for a specific application.
boolean	isDiscardComplexQuery() Discards queries containing prefix handlers and operators.
QueryReportingSuggest	makeCopy() Creates and returns a deep copy of this QueryReportingSuggest.
static QueryReportingSuggest	readFrom(java.io.InputStream is) Read this QueryReportingSuggest from an XML fragment.
void	setApplicationId(java.lang.String applicationId) Retrieves logs for a specific application.
void	setDiscardComplexQuery(boolean discardComplexQuery) Discards queries containing prefix handlers and operators.
java.lang.String	toString() String representation of this QueryReportingSuggest.
QueryReportingSuggest	withApplicationId(java.lang.String applicationId)
QueryReportingSuggest	withBlackListURL(java.lang.String blackListURL)
QueryReportingSuggest	withDiscardComplexQuery(boolean discardComplexQuery)
QueryReportingSuggest	withDiscardComplexQuery(java.lang.Boolean discardComplexQuery)
QueryReportingSuggest	withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)
QueryReportingSuggest	withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)
QueryReportingSuggest	withSuggestName(java.lang.String suggestName)
QueryReportingSuggest	withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)
QueryReportingSuggest	withWhiteListURL(java.lang.String whiteListURL)
void	writeTo(java.io.OutputStream os) Write this QueryReportingSuggest as an XML fragment

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

discardComplexQuery

public boolean discardComplexQuery

DEFAULT_DISCARD_COMPLEX_QUERY

public static final boolean DEFAULT_DISCARD_COMPLEX_QUERY

See Also:

Constant Field Values

applicationId

public java.lang.String applicationId

Constructor Detail

QueryReportingSuggest

public QueryReportingSuggest()

QueryReportingSuggest

public QueryReportingSuggest(QueryReportingSuggest o)

Copy constructor

Method Detail

withSuggestBuildTrigger

public QueryReportingSuggest withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)

Overrides:

withSuggestBuildTrigger in class BuildableSuggest

withSuggestBuildConfig

public QueryReportingSuggest withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)

Overrides:

withSuggestBuildConfig in class BuildableSuggest

withSuggestName

public QueryReportingSuggest withSuggestName(java.lang.String suggestName)

Overrides:

withSuggestName in class BuildableSuggest

withWhiteListURL

public QueryReportingSuggest withWhiteListURL(java.lang.String whiteListURL)

Overrides:

withWhiteListURL in class BuildableSuggest

withBlackListURL

public QueryReportingSuggest withBlackListURL(java.lang.String blackListURL)

Overrides:

withBlackListURL in class BuildableSuggest

withSuggestQueryConfig

public QueryReportingSuggest withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)

Overrides:

withSuggestQueryConfig in class BuildableSuggest

setDiscardComplexQuery

public void setDiscardComplexQuery(boolean discardComplexQuery)

Discards queries containing prefix handlers and operators.

isDiscardComplexQuery

public boolean isDiscardComplexQuery()

Discards queries containing prefix handlers and operators.

withDiscardComplexQuery

public QueryReportingSuggest withDiscardComplexQuery(boolean discardComplexQuery)

withDiscardComplexQuery

public QueryReportingSuggest withDiscardComplexQuery(java.lang.Boolean discardComplexQuery)

setApplicationId

public void setApplicationId(java.lang.String applicationId)

Retrieves logs for a specific application.

getApplicationId

public java.lang.String getApplicationId()

Retrieves logs for a specific application.

withApplicationId

public QueryReportingSuggest withApplicationId(java.lang.String applicationId)

makeCopy

public QueryReportingSuggest makeCopy()

Creates and returns a deep copy of this QueryReportingSuggest.

Overrides:

makeCopy in class BuildableSuggest

readFrom

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

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

Overrides:

writeTo in class BuildableSuggest

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this QueryReportingSuggest.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this QueryReportingSuggest.

Overrides:

toString in class BuildableSuggest

check

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

Checks this QueryReportingSuggest.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BuildableSuggest

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(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