com.exalead.mercury.mami.search.v20

Class PrefixHandlerSuggestPair

java.lang.Object

com.exalead.mercury.mami.search.v20.PrefixHandlerSuggestPair

All Implemented Interfaces:

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

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

Maps a prefix handler to a suggest dictionary. You can map as many pairs as needed.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_NB_RESULTS
static boolean	DEFAULT_USE_IN_DEFAULT_SUGGEST
int	maxNbResults
java.lang.String	prefixHandler
java.lang.String	suggestName
boolean	useInDefaultSuggest

Constructor Summary

Constructors

Constructor and Description
PrefixHandlerSuggestPair()
PrefixHandlerSuggestPair(PrefixHandlerSuggestPair o) Copy constructor
PrefixHandlerSuggestPair(java.lang.String prefixHandler, java.lang.String suggestName)

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PrefixHandlerSuggestPair.
static PrefixHandlerSuggestPair	fromString(java.lang.String s) String representation of this PrefixHandlerSuggestPair.
int	getMaxNbResults() Max number of suggest entries returned by this suggest
java.lang.String	getPrefixHandler() A prefix handler name or alias
java.lang.String	getSuggestName() An existing suggest name
boolean	isUseInDefaultSuggest() Select Default to specify the suggest dictionary to use by default for a specific prefix handler.
PrefixHandlerSuggestPair	makeCopy() Creates and returns a deep copy of this PrefixHandlerSuggestPair.
static PrefixHandlerSuggestPair	readFrom(java.io.InputStream is) Read this PrefixHandlerSuggestPair from an XML fragment.
void	setMaxNbResults(int maxNbResults) Max number of suggest entries returned by this suggest
void	setPrefixHandler(java.lang.String prefixHandler) A prefix handler name or alias
void	setSuggestName(java.lang.String suggestName) An existing suggest name
void	setUseInDefaultSuggest(boolean useInDefaultSuggest) Select Default to specify the suggest dictionary to use by default for a specific prefix handler.
java.lang.String	toString() String representation of this PrefixHandlerSuggestPair.
PrefixHandlerSuggestPair	withMaxNbResults(int maxNbResults)
PrefixHandlerSuggestPair	withMaxNbResults(java.lang.Integer maxNbResults)
PrefixHandlerSuggestPair	withPrefixHandler(java.lang.String prefixHandler)
PrefixHandlerSuggestPair	withSuggestName(java.lang.String suggestName)
PrefixHandlerSuggestPair	withUseInDefaultSuggest(boolean useInDefaultSuggest)
PrefixHandlerSuggestPair	withUseInDefaultSuggest(java.lang.Boolean useInDefaultSuggest)
void	writeTo(java.io.OutputStream os) Write this PrefixHandlerSuggestPair as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

prefixHandler

public java.lang.String prefixHandler

suggestName

public java.lang.String suggestName

maxNbResults

public int maxNbResults

DEFAULT_MAX_NB_RESULTS

public static final int DEFAULT_MAX_NB_RESULTS

See Also:

Constant Field Values

useInDefaultSuggest

public boolean useInDefaultSuggest

DEFAULT_USE_IN_DEFAULT_SUGGEST

public static final boolean DEFAULT_USE_IN_DEFAULT_SUGGEST

See Also:

Constant Field Values

Constructor Detail

PrefixHandlerSuggestPair

public PrefixHandlerSuggestPair()

PrefixHandlerSuggestPair

public PrefixHandlerSuggestPair(java.lang.String prefixHandler,
                                java.lang.String suggestName)

PrefixHandlerSuggestPair

public PrefixHandlerSuggestPair(PrefixHandlerSuggestPair o)

Copy constructor

Method Detail

setPrefixHandler

public void setPrefixHandler(java.lang.String prefixHandler)

A prefix handler name or alias

getPrefixHandler

public java.lang.String getPrefixHandler()

A prefix handler name or alias

withPrefixHandler

public PrefixHandlerSuggestPair withPrefixHandler(java.lang.String prefixHandler)

setSuggestName

public void setSuggestName(java.lang.String suggestName)

An existing suggest name

getSuggestName

public java.lang.String getSuggestName()

An existing suggest name

withSuggestName

public PrefixHandlerSuggestPair withSuggestName(java.lang.String suggestName)

setMaxNbResults

public void setMaxNbResults(int maxNbResults)

Max number of suggest entries returned by this suggest

getMaxNbResults

public int getMaxNbResults()

Max number of suggest entries returned by this suggest

withMaxNbResults

public PrefixHandlerSuggestPair withMaxNbResults(int maxNbResults)

withMaxNbResults

public PrefixHandlerSuggestPair withMaxNbResults(java.lang.Integer maxNbResults)

setUseInDefaultSuggest

public void setUseInDefaultSuggest(boolean useInDefaultSuggest)

Select Default to specify the suggest dictionary to use by default for a specific prefix handler.
Note that you must specify at least one default suggest to use the following options:

• Match whole query
• Use default suggest for non configured prefix
• Add prefix handler to suggestion

isUseInDefaultSuggest

public boolean isUseInDefaultSuggest()

Select Default to specify the suggest dictionary to use by default for a specific prefix handler.
Note that you must specify at least one default suggest to use the following options:

• Match whole query
• Use default suggest for non configured prefix
• Add prefix handler to suggestion

withUseInDefaultSuggest

public PrefixHandlerSuggestPair withUseInDefaultSuggest(boolean useInDefaultSuggest)

withUseInDefaultSuggest

public PrefixHandlerSuggestPair withUseInDefaultSuggest(java.lang.Boolean useInDefaultSuggest)

makeCopy

public PrefixHandlerSuggestPair makeCopy()

Creates and returns a deep copy of this PrefixHandlerSuggestPair.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PrefixHandlerSuggestPair.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PrefixHandlerSuggestPair.

Overrides:

toString in class java.lang.Object

check

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

Checks this PrefixHandlerSuggestPair.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException