com.exalead.mercury.mami.search.v20

Class BaseSearchCommand

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

QueryExpansionCommand, SearchCommand, SpellCheckCommand

public abstract class BaseSearchCommand
extends Command
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	BaseSearchCommand.CustomRunnerFactoryParams
static interface	BaseSearchCommand.Transformer<T>
static interface	BaseSearchCommand.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	customRunnerFactoryClassId Deprecated.
protected BaseSearchCommand.CustomRunnerFactoryParams	customRunnerFactoryParams
static int	DEFAULT_MAX_CONCURRENT_QUERIES
static int	DEFAULT_MAX_WAITING_QUERIES
java.lang.String	defaultLogic
java.lang.String	defaultTarget
int	maxConcurrentQueries
int	maxWaitingQueries
java.lang.String	targetReporting

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

base, DEFAULT_BASE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(BaseSearchCommand.Transformer<T> transformer, T[] t)
abstract void	accept(BaseSearchCommand.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this BaseSearchCommand.
static BaseSearchCommand	fromString(java.lang.String s) String representation of this BaseSearchCommand.
java.lang.String	getCustomRunnerFactoryClassId() Deprecated.
BaseSearchCommand.CustomRunnerFactoryParams	getCustomRunnerFactoryParams()
java.lang.String	getDefaultLogic() Default search logic (can be overriden using API parameters).
java.lang.String	getDefaultTarget() Default search target (can be overriden using API parameters).
int	getMaxConcurrentQueries() The maximum number of concurrent queries processed by the search server.
int	getMaxWaitingQueries() When the maximum number of concurrent queries is reached the queries are put in a queue.
java.lang.String	getTargetReporting() Target reporting to use for the search queries.
BaseSearchCommand	makeCopy()
static BaseSearchCommand	readFrom(java.io.InputStream is) Read this BaseSearchCommand from an XML fragment.
void	setCustomRunnerFactoryClassId(java.lang.String customRunnerFactoryClassId) Deprecated.
void	setCustomRunnerFactoryParams(BaseSearchCommand.CustomRunnerFactoryParams __value)
void	setDefaultLogic(java.lang.String defaultLogic) Default search logic (can be overriden using API parameters).
void	setDefaultTarget(java.lang.String defaultTarget) Default search target (can be overriden using API parameters).
void	setMaxConcurrentQueries(int maxConcurrentQueries) The maximum number of concurrent queries processed by the search server.
void	setMaxWaitingQueries(int maxWaitingQueries) When the maximum number of concurrent queries is reached the queries are put in a queue.
void	setTargetReporting(java.lang.String targetReporting) Target reporting to use for the search queries.
java.lang.String	toString() String representation of this BaseSearchCommand.
BaseSearchCommand	withBase(java.lang.String base)
BaseSearchCommand	withCustomRunnerFactoryClassId(java.lang.String customRunnerFactoryClassId) Deprecated.
BaseSearchCommand	withCustomRunnerFactoryParams(BaseSearchCommand.CustomRunnerFactoryParams __value)
BaseSearchCommand	withCustomRunnerFactoryParams(java.util.Collection<KeyValue> __values)
BaseSearchCommand	withCustomRunnerFactoryParams(KeyValue... __values)
BaseSearchCommand	withDefaultLogic(java.lang.String defaultLogic)
BaseSearchCommand	withDefaultTarget(java.lang.String defaultTarget)
BaseSearchCommand	withMaxConcurrentQueries(int maxConcurrentQueries)
BaseSearchCommand	withMaxConcurrentQueries(java.lang.Integer maxConcurrentQueries)
BaseSearchCommand	withMaxWaitingQueries(int maxWaitingQueries)
BaseSearchCommand	withMaxWaitingQueries(java.lang.Integer maxWaitingQueries)
BaseSearchCommand	withTargetReporting(java.lang.String targetReporting)
void	writeTo(java.io.OutputStream os)

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

accept, accept, getBase, setBase

Methods inherited from class java.lang.Object

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

Field Detail

defaultLogic

public java.lang.String defaultLogic

defaultTarget

public java.lang.String defaultTarget

targetReporting

public java.lang.String targetReporting

customRunnerFactoryClassId

@Deprecated
public java.lang.String customRunnerFactoryClassId

Deprecated.

customRunnerFactoryParams

protected BaseSearchCommand.CustomRunnerFactoryParams customRunnerFactoryParams

maxConcurrentQueries

public int maxConcurrentQueries

DEFAULT_MAX_CONCURRENT_QUERIES

public static final int DEFAULT_MAX_CONCURRENT_QUERIES

See Also:

Constant Field Values

maxWaitingQueries

public int maxWaitingQueries

DEFAULT_MAX_WAITING_QUERIES

public static final int DEFAULT_MAX_WAITING_QUERIES

See Also:

Constant Field Values

Constructor Detail

BaseSearchCommand

public BaseSearchCommand()

BaseSearchCommand

public BaseSearchCommand(BaseSearchCommand o)

Copy constructor

Method Detail

withBase

public BaseSearchCommand withBase(java.lang.String base)

Overrides:

withBase in class Command

setDefaultLogic

public void setDefaultLogic(java.lang.String defaultLogic)

Default search logic (can be overriden using API parameters).

getDefaultLogic

public java.lang.String getDefaultLogic()

Default search logic (can be overriden using API parameters).

withDefaultLogic

public BaseSearchCommand withDefaultLogic(java.lang.String defaultLogic)

setDefaultTarget

public void setDefaultTarget(java.lang.String defaultTarget)

Default search target (can be overriden using API parameters).

getDefaultTarget

public java.lang.String getDefaultTarget()

Default search target (can be overriden using API parameters).

withDefaultTarget

public BaseSearchCommand withDefaultTarget(java.lang.String defaultTarget)

setTargetReporting

public void setTargetReporting(java.lang.String targetReporting)

Target reporting to use for the search queries.

getTargetReporting

public java.lang.String getTargetReporting()

Target reporting to use for the search queries.

withTargetReporting

public BaseSearchCommand withTargetReporting(java.lang.String targetReporting)

setCustomRunnerFactoryClassId

@Deprecated
public void setCustomRunnerFactoryClassId(java.lang.String customRunnerFactoryClassId)

Deprecated.

getCustomRunnerFactoryClassId

@Deprecated
public java.lang.String getCustomRunnerFactoryClassId()

Deprecated.

withCustomRunnerFactoryClassId

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

Deprecated.

getCustomRunnerFactoryParams

public BaseSearchCommand.CustomRunnerFactoryParams getCustomRunnerFactoryParams()

setCustomRunnerFactoryParams

public void setCustomRunnerFactoryParams(BaseSearchCommand.CustomRunnerFactoryParams __value)

withCustomRunnerFactoryParams

public BaseSearchCommand withCustomRunnerFactoryParams(KeyValue... __values)

withCustomRunnerFactoryParams

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

withCustomRunnerFactoryParams

public BaseSearchCommand withCustomRunnerFactoryParams(BaseSearchCommand.CustomRunnerFactoryParams __value)

setMaxConcurrentQueries

public void setMaxConcurrentQueries(int maxConcurrentQueries)

The maximum number of concurrent queries processed by the search server. If this limit is reached, incoming queries will be queued.
0 means the number of core of the search server times two.

getMaxConcurrentQueries

public int getMaxConcurrentQueries()

The maximum number of concurrent queries processed by the search server. If this limit is reached, incoming queries will be queued.
0 means the number of core of the search server times two.

withMaxConcurrentQueries

public BaseSearchCommand withMaxConcurrentQueries(int maxConcurrentQueries)

withMaxConcurrentQueries

public BaseSearchCommand withMaxConcurrentQueries(java.lang.Integer maxConcurrentQueries)

setMaxWaitingQueries

public void setMaxWaitingQueries(int maxWaitingQueries)

When the maximum number of concurrent queries is reached the queries are put in a queue. This setting configures the maximum length of this queue. When this maximum is reached the query is rejected.

getMaxWaitingQueries

public int getMaxWaitingQueries()

When the maximum number of concurrent queries is reached the queries are put in a queue. This setting configures the maximum length of this queue. When this maximum is reached the query is rejected.

withMaxWaitingQueries

public BaseSearchCommand withMaxWaitingQueries(int maxWaitingQueries)

withMaxWaitingQueries

public BaseSearchCommand withMaxWaitingQueries(java.lang.Integer maxWaitingQueries)

makeCopy

public BaseSearchCommand makeCopy()

Overrides:

makeCopy in class Command

readFrom

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

Read this BaseSearchCommand 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

Overrides:

writeTo in class Command

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this BaseSearchCommand.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this BaseSearchCommand.

Overrides:

toString in class Command

check

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

Checks this BaseSearchCommand.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Command

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException