com.exalead.mercury.mami.search.v20

Class SuggestDispatcher

java.lang.Object

com.exalead.mercury.mami.search.v20.SuggestDispatcher

All Implemented Interfaces:

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

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

A SuggestDispatcher associates prefix handlers to Suggests.
It may be used by the SuggestCommand to dispatch a relevant part of a query to the right suggest.
For example, given a query "title: test", it will send "test" to the Suggest attached to the "title" prefix handler.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SuggestDispatcher.DesignedForLogics

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addQuotes
boolean	boostVariety
static boolean	DEFAULT_ADD_QUOTES
static boolean	DEFAULT_BOOST_VARIETY
static boolean	DEFAULT_DISPLAY_PREFIX_IN_SUGGEST
static boolean	DEFAULT_MATCH_WHOLE_QUERY
static int	DEFAULT_MAX_NB_RESULTS
static boolean	DEFAULT_USE_WITH_UNKNOWN_PREFIX
protected SuggestDispatcher.DesignedForLogics	designedForLogics
boolean	displayPrefixInSuggest
boolean	matchWholeQuery
int	maxNbResults
java.lang.String	name
java.util.List<PrefixHandlerSuggestPair>	prefixHandlerSuggestPair
boolean	useWithUnknownPrefix

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SuggestDispatcher.
static SuggestDispatcher	fromString(java.lang.String s) String representation of this SuggestDispatcher.
SuggestDispatcher.DesignedForLogics	getDesignedForLogics()
int	getMaxNbResults() Max number of suggest entries returned by this suggest dispatcher (0 returns all available entries).
java.lang.String	getName() The mandatory suggest dispatcher name.
java.util.List<PrefixHandlerSuggestPair>	getPrefixHandlerSuggestPair() Association of a prefix handler and a suggest
boolean	isAddQuotes() Adds quotes where necessary so that the whole suggestion is included in the prefix handler.
boolean	isBoostVariety() Allows to retrieve the best matches for each suggest according to the maximum number of suggestions.
boolean	isDisplayPrefixInSuggest() When activated, the suggest is prefixed by the corresponding prefix handler if defined.
boolean	isMatchWholeQuery() Sends the whole query to the default suggest if the cursor is outside a prefix handler. If unselected, it sends a subquery delimited by surrounding prefixes.
boolean	isUseWithUnknownPrefix() Sends the query to the default suggest if the cursor is within an undefined prefix handler. If unselected, undefined prefix handlers are ignored and there will be no suggestions.
SuggestDispatcher	makeCopy() Creates and returns a deep copy of this SuggestDispatcher.
static SuggestDispatcher	readFrom(java.io.InputStream is) Read this SuggestDispatcher from an XML fragment.
void	setAddQuotes(boolean addQuotes) Adds quotes where necessary so that the whole suggestion is included in the prefix handler.
void	setBoostVariety(boolean boostVariety) Allows to retrieve the best matches for each suggest according to the maximum number of suggestions.
void	setDesignedForLogics(SuggestDispatcher.DesignedForLogics __value)
void	setDisplayPrefixInSuggest(boolean displayPrefixInSuggest) When activated, the suggest is prefixed by the corresponding prefix handler if defined.
void	setMatchWholeQuery(boolean matchWholeQuery) Sends the whole query to the default suggest if the cursor is outside a prefix handler. If unselected, it sends a subquery delimited by surrounding prefixes.
void	setMaxNbResults(int maxNbResults) Max number of suggest entries returned by this suggest dispatcher (0 returns all available entries).
void	setName(java.lang.String name) The mandatory suggest dispatcher name.
void	setUseWithUnknownPrefix(boolean useWithUnknownPrefix) Sends the query to the default suggest if the cursor is within an undefined prefix handler. If unselected, undefined prefix handlers are ignored and there will be no suggestions.
java.lang.String	toString() String representation of this SuggestDispatcher.
SuggestDispatcher	withAddQuotes(boolean addQuotes)
SuggestDispatcher	withAddQuotes(java.lang.Boolean addQuotes)
SuggestDispatcher	withBoostVariety(boolean boostVariety)
SuggestDispatcher	withBoostVariety(java.lang.Boolean boostVariety)
SuggestDispatcher	withDesignedForLogics(java.util.Collection<StringValue> __values)
SuggestDispatcher	withDesignedForLogics(StringValue... __values)
SuggestDispatcher	withDesignedForLogics(SuggestDispatcher.DesignedForLogics __value)
SuggestDispatcher	withDisplayPrefixInSuggest(boolean displayPrefixInSuggest)
SuggestDispatcher	withDisplayPrefixInSuggest(java.lang.Boolean displayPrefixInSuggest)
SuggestDispatcher	withMatchWholeQuery(boolean matchWholeQuery)
SuggestDispatcher	withMatchWholeQuery(java.lang.Boolean matchWholeQuery)
SuggestDispatcher	withMaxNbResults(int maxNbResults)
SuggestDispatcher	withMaxNbResults(java.lang.Integer maxNbResults)
SuggestDispatcher	withName(java.lang.String name)
SuggestDispatcher	withPrefixHandlerSuggestPair(java.util.Collection<PrefixHandlerSuggestPair> __values)
SuggestDispatcher	withPrefixHandlerSuggestPair(PrefixHandlerSuggestPair... __values) Association of a prefix handler and a suggest
SuggestDispatcher	withUseWithUnknownPrefix(boolean useWithUnknownPrefix)
SuggestDispatcher	withUseWithUnknownPrefix(java.lang.Boolean useWithUnknownPrefix)
void	writeTo(java.io.OutputStream os) Write this SuggestDispatcher as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

prefixHandlerSuggestPair

public java.util.List<PrefixHandlerSuggestPair> prefixHandlerSuggestPair

name

public java.lang.String name

matchWholeQuery

public boolean matchWholeQuery

DEFAULT_MATCH_WHOLE_QUERY

public static final boolean DEFAULT_MATCH_WHOLE_QUERY

See Also:

Constant Field Values

useWithUnknownPrefix

public boolean useWithUnknownPrefix

DEFAULT_USE_WITH_UNKNOWN_PREFIX

public static final boolean DEFAULT_USE_WITH_UNKNOWN_PREFIX

See Also:

Constant Field Values

designedForLogics

protected SuggestDispatcher.DesignedForLogics designedForLogics

addQuotes

public boolean addQuotes

DEFAULT_ADD_QUOTES

public static final boolean DEFAULT_ADD_QUOTES

See Also:

Constant Field Values

displayPrefixInSuggest

public boolean displayPrefixInSuggest

DEFAULT_DISPLAY_PREFIX_IN_SUGGEST

public static final boolean DEFAULT_DISPLAY_PREFIX_IN_SUGGEST

See Also:

Constant Field Values

maxNbResults

public int maxNbResults

DEFAULT_MAX_NB_RESULTS

public static final int DEFAULT_MAX_NB_RESULTS

See Also:

Constant Field Values

boostVariety

public boolean boostVariety

DEFAULT_BOOST_VARIETY

public static final boolean DEFAULT_BOOST_VARIETY

See Also:

Constant Field Values

Constructor Detail

SuggestDispatcher

public SuggestDispatcher()

SuggestDispatcher

public SuggestDispatcher(SuggestDispatcher o)

Copy constructor

Method Detail

getPrefixHandlerSuggestPair

public java.util.List<PrefixHandlerSuggestPair> getPrefixHandlerSuggestPair()

Association of a prefix handler and a suggest

withPrefixHandlerSuggestPair

public SuggestDispatcher withPrefixHandlerSuggestPair(PrefixHandlerSuggestPair... __values)

Association of a prefix handler and a suggest

withPrefixHandlerSuggestPair

public SuggestDispatcher withPrefixHandlerSuggestPair(java.util.Collection<PrefixHandlerSuggestPair> __values)

setName

public void setName(java.lang.String name)

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

getName

public java.lang.String getName()

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

withName

public SuggestDispatcher withName(java.lang.String name)

setMatchWholeQuery

public void setMatchWholeQuery(boolean matchWholeQuery)

Sends the whole query to the default suggest if the cursor is outside a prefix handler.
If unselected, it sends a subquery delimited by surrounding prefixes.

isMatchWholeQuery

public boolean isMatchWholeQuery()

Sends the whole query to the default suggest if the cursor is outside a prefix handler.
If unselected, it sends a subquery delimited by surrounding prefixes.

withMatchWholeQuery

public SuggestDispatcher withMatchWholeQuery(boolean matchWholeQuery)

withMatchWholeQuery

public SuggestDispatcher withMatchWholeQuery(java.lang.Boolean matchWholeQuery)

setUseWithUnknownPrefix

public void setUseWithUnknownPrefix(boolean useWithUnknownPrefix)

Sends the query to the default suggest if the cursor is within an undefined prefix handler.
If unselected, undefined prefix handlers are ignored and there will be no suggestions.

isUseWithUnknownPrefix

public boolean isUseWithUnknownPrefix()

Sends the query to the default suggest if the cursor is within an undefined prefix handler.
If unselected, undefined prefix handlers are ignored and there will be no suggestions.

withUseWithUnknownPrefix

public SuggestDispatcher withUseWithUnknownPrefix(boolean useWithUnknownPrefix)

withUseWithUnknownPrefix

public SuggestDispatcher withUseWithUnknownPrefix(java.lang.Boolean useWithUnknownPrefix)

getDesignedForLogics

public SuggestDispatcher.DesignedForLogics getDesignedForLogics()

setDesignedForLogics

public void setDesignedForLogics(SuggestDispatcher.DesignedForLogics __value)

withDesignedForLogics

public SuggestDispatcher withDesignedForLogics(StringValue... __values)

withDesignedForLogics

public SuggestDispatcher withDesignedForLogics(java.util.Collection<StringValue> __values)

withDesignedForLogics

public SuggestDispatcher withDesignedForLogics(SuggestDispatcher.DesignedForLogics __value)

setAddQuotes

public void setAddQuotes(boolean addQuotes)

Adds quotes where necessary so that the whole suggestion is included in the prefix handler.

isAddQuotes

public boolean isAddQuotes()

Adds quotes where necessary so that the whole suggestion is included in the prefix handler.

withAddQuotes

public SuggestDispatcher withAddQuotes(boolean addQuotes)

withAddQuotes

public SuggestDispatcher withAddQuotes(java.lang.Boolean addQuotes)

setDisplayPrefixInSuggest

public void setDisplayPrefixInSuggest(boolean displayPrefixInSuggest)

When activated, the suggest is prefixed by the corresponding prefix handler if defined.

isDisplayPrefixInSuggest

public boolean isDisplayPrefixInSuggest()

When activated, the suggest is prefixed by the corresponding prefix handler if defined.

withDisplayPrefixInSuggest

public SuggestDispatcher withDisplayPrefixInSuggest(boolean displayPrefixInSuggest)

withDisplayPrefixInSuggest

public SuggestDispatcher withDisplayPrefixInSuggest(java.lang.Boolean displayPrefixInSuggest)

setMaxNbResults

public void setMaxNbResults(int maxNbResults)

Max number of suggest entries returned by this suggest dispatcher (0 returns all available entries).

getMaxNbResults

public int getMaxNbResults()

Max number of suggest entries returned by this suggest dispatcher (0 returns all available entries).

withMaxNbResults

public SuggestDispatcher withMaxNbResults(int maxNbResults)

withMaxNbResults

public SuggestDispatcher withMaxNbResults(java.lang.Integer maxNbResults)

setBoostVariety

public void setBoostVariety(boolean boostVariety)

Allows to retrieve the best matches for each suggest according to the maximum number of suggestions. Note that this mode does not always return the best global results.

isBoostVariety

public boolean isBoostVariety()

Allows to retrieve the best matches for each suggest according to the maximum number of suggestions. Note that this mode does not always return the best global results.

withBoostVariety

public SuggestDispatcher withBoostVariety(boolean boostVariety)

withBoostVariety

public SuggestDispatcher withBoostVariety(java.lang.Boolean boostVariety)

makeCopy

public SuggestDispatcher makeCopy()

Creates and returns a deep copy of this SuggestDispatcher.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SuggestDispatcher.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SuggestDispatcher.

Overrides:

toString in class java.lang.Object

check

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

Checks this SuggestDispatcher.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException