com.exalead.mercury.mami.search.v20

Class DynamicFieldSuggest

java.lang.Object

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

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

com.exalead.mercury.mami.search.v20.SearchBasedSuggest

com.exalead.mercury.mami.search.v20.IndexFieldSuggest

com.exalead.mercury.mami.search.v20.DynamicFieldSuggest

All Implemented Interfaces:

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

Direct Known Subclasses:

EnoviaSecureDynamicFieldSuggest

public class DynamicFieldSuggest
extends IndexFieldSuggest
implements com.exalead.util.Checkable, java.io.Serializable

Takes the value from a subset of a dynamic index field to build a suggest.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicFieldSuggest.Mode
static interface	DynamicFieldSuggest.Transformer<T>
static interface	DynamicFieldSuggest.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_KEEP_CONTEXT
static java.lang.String	DEFAULT_MODE
boolean	keepContext
java.lang.String	mode
java.lang.String	pattern

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

DEFAULT_QUERY, indexField, logic, query, searchServerInstance, target

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
DynamicFieldSuggest()
DynamicFieldSuggest(DynamicFieldSuggest 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(DynamicFieldSuggest.Transformer<T> transformer, T[] t)
void	accept(DynamicFieldSuggest.Visitor visitor)
<T> T	accept(IndexFieldSuggest.Transformer<T> transformer, T[] t)
void	accept(IndexFieldSuggest.Visitor visitor)
<T> T	accept(SearchBasedSuggest.Transformer<T> transformer, T[] t)
void	accept(SearchBasedSuggest.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 DynamicFieldSuggest.
static DynamicFieldSuggest	fromString(java.lang.String s) String representation of this DynamicFieldSuggest.
java.lang.String	getMode() Matching mode.
DynamicFieldSuggest.Mode	getModeAsEnum() Matching mode.
java.lang.String	getPattern() The string to look for.
static boolean	isA(java.lang.String str, DynamicFieldSuggest.Mode item)
boolean	isKeepContext() When set to True, the context is kept in suggest entry.
static boolean	isOneOf(java.lang.String str, DynamicFieldSuggest.Mode... items)
DynamicFieldSuggest	makeCopy() Creates and returns a deep copy of this DynamicFieldSuggest.
static DynamicFieldSuggest	readFrom(java.io.InputStream is) Read this DynamicFieldSuggest from an XML fragment.
void	setKeepContext(boolean keepContext) When set to True, the context is kept in suggest entry.
void	setMode(DynamicFieldSuggest.Mode item) Matching mode.
void	setMode(java.lang.String mode) Matching mode.
void	setPattern(java.lang.String pattern) The string to look for.
java.lang.String	toString() String representation of this DynamicFieldSuggest.
DynamicFieldSuggest	withBlackListURL(java.lang.String blackListURL)
DynamicFieldSuggest	withIndexField(java.lang.String indexField)
DynamicFieldSuggest	withKeepContext(boolean keepContext)
DynamicFieldSuggest	withKeepContext(java.lang.Boolean keepContext)
DynamicFieldSuggest	withLogic(java.lang.String logic)
DynamicFieldSuggest	withMode(java.lang.String mode)
DynamicFieldSuggest	withPattern(java.lang.String pattern)
DynamicFieldSuggest	withQuery(java.lang.String query)
DynamicFieldSuggest	withSearchServerInstance(java.lang.String searchServerInstance)
DynamicFieldSuggest	withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)
DynamicFieldSuggest	withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)
DynamicFieldSuggest	withSuggestName(java.lang.String suggestName)
DynamicFieldSuggest	withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)
DynamicFieldSuggest	withTarget(java.lang.String target)
DynamicFieldSuggest	withWhiteListURL(java.lang.String whiteListURL)
void	writeTo(java.io.OutputStream os) Write this DynamicFieldSuggest as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.SearchBasedSuggest

getIndexField, getLogic, getQuery, getSearchServerInstance, getTarget, setIndexField, setLogic, setQuery, setSearchServerInstance, setTarget

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

mode

public java.lang.String mode

DEFAULT_MODE

public static final java.lang.String DEFAULT_MODE

See Also:

Constant Field Values

pattern

public java.lang.String pattern

keepContext

public boolean keepContext

DEFAULT_KEEP_CONTEXT

public static final boolean DEFAULT_KEEP_CONTEXT

See Also:

Constant Field Values

Constructor Detail

DynamicFieldSuggest

public DynamicFieldSuggest()

DynamicFieldSuggest

public DynamicFieldSuggest(DynamicFieldSuggest o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          DynamicFieldSuggest.Mode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              DynamicFieldSuggest.Mode... items)

setMode

public void setMode(DynamicFieldSuggest.Mode item)

Matching mode. If 'all' is selected, all the content of the index field will be used.

getModeAsEnum

public DynamicFieldSuggest.Mode getModeAsEnum()

Matching mode. If 'all' is selected, all the content of the index field will be used.

withLogic

public DynamicFieldSuggest withLogic(java.lang.String logic)

Overrides:

withLogic in class IndexFieldSuggest

withTarget

public DynamicFieldSuggest withTarget(java.lang.String target)

Overrides:

withTarget in class IndexFieldSuggest

withIndexField

public DynamicFieldSuggest withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class IndexFieldSuggest

withQuery

public DynamicFieldSuggest withQuery(java.lang.String query)

Overrides:

withQuery in class IndexFieldSuggest

withSearchServerInstance

public DynamicFieldSuggest withSearchServerInstance(java.lang.String searchServerInstance)

Overrides:

withSearchServerInstance in class IndexFieldSuggest

withSuggestBuildTrigger

public DynamicFieldSuggest withSuggestBuildTrigger(SuggestBuildTrigger suggestBuildTrigger)

Overrides:

withSuggestBuildTrigger in class IndexFieldSuggest

withSuggestBuildConfig

public DynamicFieldSuggest withSuggestBuildConfig(SuggestBuildConfig suggestBuildConfig)

Overrides:

withSuggestBuildConfig in class IndexFieldSuggest

withSuggestName

public DynamicFieldSuggest withSuggestName(java.lang.String suggestName)

Overrides:

withSuggestName in class IndexFieldSuggest

withWhiteListURL

public DynamicFieldSuggest withWhiteListURL(java.lang.String whiteListURL)

Overrides:

withWhiteListURL in class IndexFieldSuggest

withBlackListURL

public DynamicFieldSuggest withBlackListURL(java.lang.String blackListURL)

Overrides:

withBlackListURL in class IndexFieldSuggest

withSuggestQueryConfig

public DynamicFieldSuggest withSuggestQueryConfig(SuggestQueryConfig suggestQueryConfig)

Overrides:

withSuggestQueryConfig in class IndexFieldSuggest

setMode

public void setMode(java.lang.String mode)

Matching mode. If 'all' is selected, all the content of the index field will be used.

getMode

public java.lang.String getMode()

Matching mode. If 'all' is selected, all the content of the index field will be used.

withMode

public DynamicFieldSuggest withMode(java.lang.String mode)

setPattern

public void setPattern(java.lang.String pattern)

The string to look for.

getPattern

public java.lang.String getPattern()

The string to look for.

withPattern

public DynamicFieldSuggest withPattern(java.lang.String pattern)

setKeepContext

public void setKeepContext(boolean keepContext)

When set to True, the context is kept in suggest entry.

isKeepContext

public boolean isKeepContext()

When set to True, the context is kept in suggest entry.

withKeepContext

public DynamicFieldSuggest withKeepContext(boolean keepContext)

withKeepContext

public DynamicFieldSuggest withKeepContext(java.lang.Boolean keepContext)

makeCopy

public DynamicFieldSuggest makeCopy()

Creates and returns a deep copy of this DynamicFieldSuggest.

Overrides:

makeCopy in class IndexFieldSuggest

readFrom

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

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

Overrides:

writeTo in class IndexFieldSuggest

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DynamicFieldSuggest.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DynamicFieldSuggest.

Overrides:

toString in class IndexFieldSuggest

check

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

Checks this DynamicFieldSuggest.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class IndexFieldSuggest

Throws:

com.exalead.util.TypedException