com.exalead.mercury.mami.search.v20

Class SuggestConfig

java.lang.Object

exa.bee.config.Versioned

com.exalead.mercury.mami.search.v20.SuggestConfig

All Implemented Interfaces:

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

public class SuggestConfig
extends exa.bee.config.Versioned
implements com.exalead.util.Checkable, java.io.Serializable

List of Suggest and SuggestDispatcher

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Suggest>	suggest
java.util.List<SuggestDispatcher>	suggestDispatcher

Fields inherited from class exa.bee.config.Versioned

version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this SuggestConfig.
static SuggestConfig	fromString(java.lang.String s) String representation of this SuggestConfig.
java.util.List<Suggest>	getSuggest() List of Suggest.
java.util.Map<java.lang.String,Suggest>	getSuggestAsMap() Get the map of Suggest, indexed by suggestName
Suggest	getSuggestBySuggestName(java.lang.String _lookup) Get the Suggest for which the suggestName matches _lookup
java.util.List<SuggestDispatcher>	getSuggestDispatcher() List of SuggestDispatcher.
java.util.Map<java.lang.String,SuggestDispatcher>	getSuggestDispatcherAsMap() Get the map of SuggestDispatcher, indexed by name
SuggestDispatcher	getSuggestDispatcherByName(java.lang.String _lookup) Get the SuggestDispatcher for which the name matches _lookup
SuggestConfig	makeCopy() Creates and returns a deep copy of this SuggestConfig.
static SuggestConfig	readFrom(java.io.InputStream is) Read this SuggestConfig from an XML fragment.
boolean	removeSuggestBySuggestName(java.lang.String _lookup) Removes the Suggest for which the suggestName matches _lookup
boolean	removeSuggestDispatcherByName(java.lang.String _lookup) Removes the SuggestDispatcher for which the name matches _lookup
java.lang.String	toString() String representation of this SuggestConfig.
SuggestConfig	withSuggest(java.util.Collection<Suggest> __values)
SuggestConfig	withSuggest(Suggest... __values) List of Suggest.
SuggestConfig	withSuggestDispatcher(java.util.Collection<SuggestDispatcher> __values)
SuggestConfig	withSuggestDispatcher(SuggestDispatcher... __values) List of SuggestDispatcher.
SuggestConfig	withVersion(long version)
SuggestConfig	withVersion(java.lang.Long version)
void	writeTo(java.io.OutputStream os) Write this SuggestConfig as an XML fragment

Methods inherited from class exa.bee.config.Versioned

clone, getVersion, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

suggest

public java.util.List<Suggest> suggest

suggestDispatcher

public java.util.List<SuggestDispatcher> suggestDispatcher

Constructor Detail

SuggestConfig

public SuggestConfig()

SuggestConfig

public SuggestConfig(SuggestConfig o)

Copy constructor

Method Detail

withVersion

public SuggestConfig withVersion(long version)

Overrides:

withVersion in class exa.bee.config.Versioned

withVersion

public SuggestConfig withVersion(java.lang.Long version)

Overrides:

withVersion in class exa.bee.config.Versioned

getSuggest

public java.util.List<Suggest> getSuggest()

List of Suggest.

getSuggestBySuggestName

public Suggest getSuggestBySuggestName(java.lang.String _lookup)

Get the Suggest for which the suggestName matches _lookup

Returns:

null if no matching Suggest is found

getSuggestAsMap

public java.util.Map<java.lang.String,Suggest> getSuggestAsMap()

Get the map of Suggest, indexed by suggestName

removeSuggestBySuggestName

public boolean removeSuggestBySuggestName(java.lang.String _lookup)

Removes the Suggest for which the suggestName matches _lookup

Returns:

false if no matching Suggest is found, true if one was found

withSuggest

public SuggestConfig withSuggest(Suggest... __values)

List of Suggest.

withSuggest

public SuggestConfig withSuggest(java.util.Collection<Suggest> __values)

getSuggestDispatcher

public java.util.List<SuggestDispatcher> getSuggestDispatcher()

List of SuggestDispatcher.

getSuggestDispatcherByName

public SuggestDispatcher getSuggestDispatcherByName(java.lang.String _lookup)

Get the SuggestDispatcher for which the name matches _lookup

Returns:

null if no matching SuggestDispatcher is found

getSuggestDispatcherAsMap

public java.util.Map<java.lang.String,SuggestDispatcher> getSuggestDispatcherAsMap()

Get the map of SuggestDispatcher, indexed by name

removeSuggestDispatcherByName

public boolean removeSuggestDispatcherByName(java.lang.String _lookup)

Removes the SuggestDispatcher for which the name matches _lookup

Returns:

false if no matching SuggestDispatcher is found, true if one was found

withSuggestDispatcher

public SuggestConfig withSuggestDispatcher(SuggestDispatcher... __values)

List of SuggestDispatcher.

withSuggestDispatcher

public SuggestConfig withSuggestDispatcher(java.util.Collection<SuggestDispatcher> __values)

makeCopy

public SuggestConfig makeCopy()

Creates and returns a deep copy of this SuggestConfig.

Overrides:

makeCopy in class exa.bee.config.Versioned

readFrom

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

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

Overrides:

writeTo in class exa.bee.config.Versioned

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SuggestConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SuggestConfig.

Overrides:

toString in class exa.bee.config.Versioned

check

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

Checks this SuggestConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class exa.bee.config.Versioned

Throws:

com.exalead.util.TypedException