org.eclipse.smila.processing.parameters
Class SearchParameters

java.lang.Object
  org.eclipse.smila.processing.parameters.SearchParameters

public final class SearchParameters
extends java.lang.Object

Constants for names and values of service/pipelet parameters commonly used in search pipelines.

Author:

jschumacher

Nested Class Summary

static class

SearchParameters.OrderMode Values for the "orderBy"/"mode" parameter: Sort ascending or descending.

Field Summary

static int	DEFAULT_RESULTOFFSET default "resultOffset" value: 0.
static int	DEFAULT_RESULTSIZE default "resultSize" value: 10.
static double	DEFAULT_THRESHOLD default "threshold "value: 0.0.
static java.lang.String	INDEXNAME name of the "indexName" parameter.
static java.lang.String	LANGUAGE name of the "language" parameter.
static java.lang.String	ORDERBY name of the "orderBy" parameter subannotations.
static java.lang.String	ORDERBY_ATTRIBUTE name of the "attribute" parameter of an "orderBy" annotation.
static java.lang.String	ORDERBY_MODE name of the "mode" parameter of an "orderBy" annotation.
static java.lang.String	PARAMETERS name of the record level annotation that contains all service/pipelet runtime parameters.
static java.lang.String	QUERY name of the "query" string parameter.
static java.lang.String	RESULTATTRIBUTES name of the "resultAttributes" parameter.
static java.lang.String	RESULTOFFSET name of the "resultOffset" parameter.
static java.lang.String	RESULTSIZE name of the "resultSize" parameter.
static java.lang.String	THRESHOLD name ofthe "threshold" parameter.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETERS

public static final java.lang.String PARAMETERS

name of the record level annotation that contains all service/pipelet runtime parameters.

See Also:

Constant Field Values

QUERY

public static final java.lang.String QUERY

name of the "query" string parameter.

See Also:

Constant Field Values

RESULTATTRIBUTES

public static final java.lang.String RESULTATTRIBUTES

name of the "resultAttributes" parameter.

See Also:

Constant Field Values

RESULTSIZE

public static final java.lang.String RESULTSIZE

name of the "resultSize" parameter.

See Also:

Constant Field Values

RESULTOFFSET

public static final java.lang.String RESULTOFFSET

name of the "resultOffset" parameter.

See Also:

Constant Field Values

THRESHOLD

public static final java.lang.String THRESHOLD

name ofthe "threshold" parameter.

See Also:

Constant Field Values

LANGUAGE

public static final java.lang.String LANGUAGE

name of the "language" parameter.

See Also:

Constant Field Values

INDEXNAME

public static final java.lang.String INDEXNAME

name of the "indexName" parameter.

See Also:

Constant Field Values

ORDERBY

public static final java.lang.String ORDERBY

name of the "orderBy" parameter subannotations.

See Also:

Constant Field Values

ORDERBY_ATTRIBUTE

public static final java.lang.String ORDERBY_ATTRIBUTE

name of the "attribute" parameter of an "orderBy" annotation.

See Also:

Constant Field Values

ORDERBY_MODE

public static final java.lang.String ORDERBY_MODE

name of the "mode" parameter of an "orderBy" annotation.

See Also:

Constant Field Values

DEFAULT_RESULTSIZE

public static final int DEFAULT_RESULTSIZE

default "resultSize" value: 10.

See Also:

Constant Field Values

DEFAULT_RESULTOFFSET

public static final int DEFAULT_RESULTOFFSET

default "resultOffset" value: 0.

See Also:

Constant Field Values

DEFAULT_THRESHOLD

public static final double DEFAULT_THRESHOLD

default "threshold "value: 0.0.

See Also:

Constant Field Values