com.exalead.mercury.mami.search.v20

Class SearchCommand

java.lang.Object

com.exalead.mercury.mami.search.v20.Command

com.exalead.mercury.mami.search.v20.BaseSearchCommand

com.exalead.mercury.mami.search.v20.SearchCommand

All Implemented Interfaces:

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

public class SearchCommand
extends BaseSearchCommand
implements com.exalead.util.Checkable, java.io.Serializable

Search API command

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchCommand.IsAliveQueries

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

BaseSearchCommand.CustomRunnerFactoryParams, BaseSearchCommand.Transformer<T>, BaseSearchCommand.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLE_S_O_A_P
static int	DEFAULT_IS_ALIVE_ASYNCHRONOUS_DELAY_S
static boolean	DEFAULT_IS_ALIVE_SYNCHRONOUS
boolean	enableSOAP
int	isAliveAsynchronousDelayS
protected SearchCommand.IsAliveQueries	isAliveQueries
boolean	isAliveSynchronous
java.util.List<SearchCache>	searchCache

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

customRunnerFactoryClassId, customRunnerFactoryParams, DEFAULT_MAX_CONCURRENT_QUERIES, DEFAULT_MAX_WAITING_QUERIES, defaultLogic, defaultTarget, maxConcurrentQueries, maxWaitingQueries, targetReporting

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

base, DEFAULT_BASE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(BaseSearchCommand.Transformer<T> transformer, T[] t)
void	accept(BaseSearchCommand.Visitor visitor)
<T> T	accept(Command.Transformer<T> transformer, T[] t)
void	accept(Command.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SearchCommand.
static SearchCommand	fromString(java.lang.String s) String representation of this SearchCommand.
int	getIsAliveAsynchronousDelayS() Elapsed time between two queries if the query is performed asynchronously.
SearchCommand.IsAliveQueries	getIsAliveQueries()
java.util.List<SearchCache>	getSearchCache() List of caches for this search command. Cache entries will be looked up in all caches, in the order in which they are given. Incoming queries will be inserted in the first cache which accepts them. This allows complex configurations where you warmup some queries, and don't want them to be evicted by regular traffic
java.util.Map<java.lang.String,SearchCache>	getSearchCacheAsMap() Get the map of SearchCache, indexed by name
SearchCache	getSearchCacheByName(java.lang.String _lookup) Get the SearchCache for which the name matches _lookup
boolean	isEnableSOAP()
boolean	isIsAliveSynchronous() Should the query be performed synchronously on isAlive call or should it run in a background thread, and cached result be returned.
SearchCommand	makeCopy() Creates and returns a deep copy of this SearchCommand.
static SearchCommand	readFrom(java.io.InputStream is) Read this SearchCommand from an XML fragment.
boolean	removeSearchCacheByName(java.lang.String _lookup) Removes the SearchCache for which the name matches _lookup
void	setEnableSOAP(boolean enableSOAP)
void	setIsAliveAsynchronousDelayS(int isAliveAsynchronousDelayS) Elapsed time between two queries if the query is performed asynchronously.
void	setIsAliveQueries(SearchCommand.IsAliveQueries __value)
void	setIsAliveSynchronous(boolean isAliveSynchronous) Should the query be performed synchronously on isAlive call or should it run in a background thread, and cached result be returned.
java.lang.String	toString() String representation of this SearchCommand.
SearchCommand	withBase(java.lang.String base)
SearchCommand	withCustomRunnerFactoryClassId(java.lang.String customRunnerFactoryClassId) Deprecated.
SearchCommand	withCustomRunnerFactoryParams(java.util.Collection<KeyValue> __values)
SearchCommand	withCustomRunnerFactoryParams(KeyValue... __values) Deprecated.
SearchCommand	withDefaultLogic(java.lang.String defaultLogic)
SearchCommand	withDefaultTarget(java.lang.String defaultTarget)
SearchCommand	withEnableSOAP(boolean enableSOAP)
SearchCommand	withEnableSOAP(java.lang.Boolean enableSOAP)
SearchCommand	withIsAliveAsynchronousDelayS(int isAliveAsynchronousDelayS)
SearchCommand	withIsAliveAsynchronousDelayS(java.lang.Integer isAliveAsynchronousDelayS)
SearchCommand	withIsAliveQueries(java.util.Collection<StringValue> __values)
SearchCommand	withIsAliveQueries(SearchCommand.IsAliveQueries __value)
SearchCommand	withIsAliveQueries(StringValue... __values)
SearchCommand	withIsAliveSynchronous(boolean isAliveSynchronous)
SearchCommand	withIsAliveSynchronous(java.lang.Boolean isAliveSynchronous)
SearchCommand	withMaxConcurrentQueries(int maxConcurrentQueries)
SearchCommand	withMaxConcurrentQueries(java.lang.Integer maxConcurrentQueries)
SearchCommand	withMaxWaitingQueries(int maxWaitingQueries)
SearchCommand	withMaxWaitingQueries(java.lang.Integer maxWaitingQueries)
SearchCommand	withSearchCache(java.util.Collection<SearchCache> __values)
SearchCommand	withSearchCache(SearchCache... __values) List of caches for this search command. Cache entries will be looked up in all caches, in the order in which they are given. Incoming queries will be inserted in the first cache which accepts them. This allows complex configurations where you warmup some queries, and don't want them to be evicted by regular traffic
SearchCommand	withTargetReporting(java.lang.String targetReporting)
void	writeTo(java.io.OutputStream os) Write this SearchCommand as an XML fragment

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

getCustomRunnerFactoryClassId, getCustomRunnerFactoryParams, getDefaultLogic, getDefaultTarget, getMaxConcurrentQueries, getMaxWaitingQueries, getTargetReporting, setCustomRunnerFactoryClassId, setCustomRunnerFactoryParams, setDefaultLogic, setDefaultTarget, setMaxConcurrentQueries, setMaxWaitingQueries, setTargetReporting, withCustomRunnerFactoryParams

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

getBase, setBase

Methods inherited from class java.lang.Object

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

Field Detail

enableSOAP

public boolean enableSOAP

DEFAULT_ENABLE_S_O_A_P

public static final boolean DEFAULT_ENABLE_S_O_A_P

See Also:

Constant Field Values

searchCache

public java.util.List<SearchCache> searchCache

isAliveQueries

protected SearchCommand.IsAliveQueries isAliveQueries

isAliveSynchronous

public boolean isAliveSynchronous

DEFAULT_IS_ALIVE_SYNCHRONOUS

public static final boolean DEFAULT_IS_ALIVE_SYNCHRONOUS

See Also:

Constant Field Values

isAliveAsynchronousDelayS

public int isAliveAsynchronousDelayS

DEFAULT_IS_ALIVE_ASYNCHRONOUS_DELAY_S

public static final int DEFAULT_IS_ALIVE_ASYNCHRONOUS_DELAY_S

See Also:

Constant Field Values

Constructor Detail

SearchCommand

public SearchCommand()

SearchCommand

public SearchCommand(SearchCommand o)

Copy constructor

Method Detail

withDefaultLogic

public SearchCommand withDefaultLogic(java.lang.String defaultLogic)

Overrides:

withDefaultLogic in class BaseSearchCommand

withDefaultTarget

public SearchCommand withDefaultTarget(java.lang.String defaultTarget)

Overrides:

withDefaultTarget in class BaseSearchCommand

withTargetReporting

public SearchCommand withTargetReporting(java.lang.String targetReporting)

Overrides:

withTargetReporting in class BaseSearchCommand

withCustomRunnerFactoryClassId

@Deprecated
public SearchCommand withCustomRunnerFactoryClassId(java.lang.String customRunnerFactoryClassId)

Deprecated.

Overrides:

withCustomRunnerFactoryClassId in class BaseSearchCommand

withCustomRunnerFactoryParams

@Deprecated
public SearchCommand withCustomRunnerFactoryParams(KeyValue... __values)

Deprecated.

Overrides:

withCustomRunnerFactoryParams in class BaseSearchCommand

withCustomRunnerFactoryParams

public SearchCommand withCustomRunnerFactoryParams(java.util.Collection<KeyValue> __values)

Overrides:

withCustomRunnerFactoryParams in class BaseSearchCommand

withMaxConcurrentQueries

public SearchCommand withMaxConcurrentQueries(int maxConcurrentQueries)

Overrides:

withMaxConcurrentQueries in class BaseSearchCommand

withMaxConcurrentQueries

public SearchCommand withMaxConcurrentQueries(java.lang.Integer maxConcurrentQueries)

Overrides:

withMaxConcurrentQueries in class BaseSearchCommand

withMaxWaitingQueries

public SearchCommand withMaxWaitingQueries(int maxWaitingQueries)

Overrides:

withMaxWaitingQueries in class BaseSearchCommand

withMaxWaitingQueries

public SearchCommand withMaxWaitingQueries(java.lang.Integer maxWaitingQueries)

Overrides:

withMaxWaitingQueries in class BaseSearchCommand

withBase

public SearchCommand withBase(java.lang.String base)

Overrides:

withBase in class BaseSearchCommand

setEnableSOAP

public void setEnableSOAP(boolean enableSOAP)

isEnableSOAP

public boolean isEnableSOAP()

withEnableSOAP

public SearchCommand withEnableSOAP(boolean enableSOAP)

withEnableSOAP

public SearchCommand withEnableSOAP(java.lang.Boolean enableSOAP)

getSearchCache

public java.util.List<SearchCache> getSearchCache()

List of caches for this search command.
Cache entries will be looked up in all caches, in the order in which they are given.
Incoming queries will be inserted in the first cache which accepts them.
This allows complex configurations where you warmup some queries, and don't want them to be evicted by regular traffic

getSearchCacheByName

public SearchCache getSearchCacheByName(java.lang.String _lookup)

Get the SearchCache for which the name matches _lookup

Returns:

null if no matching SearchCache is found

getSearchCacheAsMap

public java.util.Map<java.lang.String,SearchCache> getSearchCacheAsMap()

Get the map of SearchCache, indexed by name

removeSearchCacheByName

public boolean removeSearchCacheByName(java.lang.String _lookup)

Removes the SearchCache for which the name matches _lookup

Returns:

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

withSearchCache

public SearchCommand withSearchCache(SearchCache... __values)

List of caches for this search command.
Cache entries will be looked up in all caches, in the order in which they are given.
Incoming queries will be inserted in the first cache which accepts them.
This allows complex configurations where you warmup some queries, and don't want them to be evicted by regular traffic

withSearchCache

public SearchCommand withSearchCache(java.util.Collection<SearchCache> __values)

getIsAliveQueries

public SearchCommand.IsAliveQueries getIsAliveQueries()

setIsAliveQueries

public void setIsAliveQueries(SearchCommand.IsAliveQueries __value)

withIsAliveQueries

public SearchCommand withIsAliveQueries(StringValue... __values)

withIsAliveQueries

public SearchCommand withIsAliveQueries(java.util.Collection<StringValue> __values)

withIsAliveQueries

public SearchCommand withIsAliveQueries(SearchCommand.IsAliveQueries __value)

setIsAliveSynchronous

public void setIsAliveSynchronous(boolean isAliveSynchronous)

Should the query be performed synchronously on isAlive call or should it run in a background thread, and cached result be returned.

isIsAliveSynchronous

public boolean isIsAliveSynchronous()

Should the query be performed synchronously on isAlive call or should it run in a background thread, and cached result be returned.

withIsAliveSynchronous

public SearchCommand withIsAliveSynchronous(boolean isAliveSynchronous)

withIsAliveSynchronous

public SearchCommand withIsAliveSynchronous(java.lang.Boolean isAliveSynchronous)

setIsAliveAsynchronousDelayS

public void setIsAliveAsynchronousDelayS(int isAliveAsynchronousDelayS)

Elapsed time between two queries if the query is performed asynchronously.

getIsAliveAsynchronousDelayS

public int getIsAliveAsynchronousDelayS()

Elapsed time between two queries if the query is performed asynchronously.

withIsAliveAsynchronousDelayS

public SearchCommand withIsAliveAsynchronousDelayS(int isAliveAsynchronousDelayS)

withIsAliveAsynchronousDelayS

public SearchCommand withIsAliveAsynchronousDelayS(java.lang.Integer isAliveAsynchronousDelayS)

makeCopy

public SearchCommand makeCopy()

Creates and returns a deep copy of this SearchCommand.

Overrides:

makeCopy in class BaseSearchCommand

readFrom

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

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

Overrides:

writeTo in class BaseSearchCommand

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SearchCommand.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SearchCommand.

Overrides:

toString in class BaseSearchCommand

check

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

Checks this SearchCommand.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BaseSearchCommand

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class BaseSearchCommand

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class Command

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class BaseSearchCommand

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class Command

Throws:

com.exalead.util.TypedException