QueryConstants (SMILA 1.1 API documentation)

java.lang.Object
- org.eclipse.smila.search.api.QueryConstants

```
public final class QueryConstants
extends java.lang.Object
```
Constants for names and values of service/pipelet parameters commonly used in search pipelines.

Author:

jschumacher

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QueryConstants.SortOrder
Values for the "orderBy"/"mode" parameter: Sort ascending or descending.

Nested Classes
Modifier and Type	Class and Description
`static class`	`QueryConstants.SortOrder` Values for the "orderBy"/"mode" parameter: Sort ascending or descending.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTE` name of the "attribute" parameter of an "sortby" or "facetby" parameter.
`static int`	`DEFAULT_MAXCOUNT` default "resultSize" value: 10.
`static int`	`DEFAULT_OFFSET` default "resultOffset" value: 0.
`static double`	`DEFAULT_THRESHOLD` default "threshold "value: 0.0.
`static java.lang.String`	`FACETBY` name of the "facetby" parameter.
`static java.lang.String`	`FACETBY_SORTCRITERION` name of the "facetby" section "attribute" parameter.
`static java.lang.String`	`FILTER` name of "filter" parameter.
`static java.lang.String`	`FILTER_ALLOF`
`static java.lang.String`	`FILTER_ATLEAST`
`static java.lang.String`	`FILTER_ATMOST`
`static java.lang.String`	`FILTER_GREATERTHAN`
`static java.lang.String`	`FILTER_LESSTHAN`
`static java.lang.String`	`FILTER_NONEOF`
`static java.lang.String`	`FILTER_ONEOF` at least one of the given values must match.
`static java.lang.String`	`GROUPBY` GROUPBY
`static java.lang.String`	`GROUPBY_AS_MAIN_RESULT` GROUPBY_AS_MAIN_RESULT
`static java.lang.String`	`HIGHLIGHT` name of the "highlight" parameter.
`static java.lang.String`	`INDEXNAME` name of the "index" parameter.
`static java.lang.String`	`LANGUAGE` name of the "language" parameter.
`static java.lang.String`	`MAXCOUNT` name of the "maxcount" parameter.
`static java.lang.String`	`NATIVE_PARAMETERS` name of a nested map to hold arbitrary parameters native to the underlying search technology.
`static java.lang.String`	`OFFSET` name of the "offset" parameter.
`static java.lang.String`	`ORDER` name of the "order" parameter of an "sortby" or "facetby" parameter.
`static java.lang.String`	`QUERY` name of the "query" part of the request record.
`static java.lang.String`	`RANKING` name of "ranking" parameter for specifying ranking criteria.
`static java.lang.String`	`RESULTATTRIBUTES` name of the "resultAttributes" parameter.
`static java.lang.String`	`SORTBY` name of the "sortby" parameter subparameters.
`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
  - QUERY
```
public static final java.lang.String QUERY
```
    name of the "query" part of the request record.
    
    See Also:
    Constant Field Values
  - MAXCOUNT
```
public static final java.lang.String MAXCOUNT
```
    name of the "maxcount" parameter.
    
    See Also:
    Constant Field Values
  - OFFSET
```
public static final java.lang.String OFFSET
```
    name of the "offset" 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 "index" parameter.
    
    See Also:
    Constant Field Values
  - HIGHLIGHT
```
public static final java.lang.String HIGHLIGHT
```
    name of the "highlight" parameter. The value is either just a seq of names of attributes to highlight, or a seq of maps with more detailed highlighting configs for different attributes.
    
    See Also:
    Constant Field Values
  - FACETBY
```
public static final java.lang.String FACETBY
```
    name of the "facetby" parameter. The parameter value is seq of maps containing "attribute", "maxcount", and optionally a "sorty" spec with "criterion" and "order"
    
    See Also:
    Constant Field Values
  - FACETBY_SORTCRITERION
```
public static final java.lang.String FACETBY_SORTCRITERION
```
    name of the "facetby" section "attribute" parameter.
    
    See Also:
    Constant Field Values
  - RANKING
```
public static final java.lang.String RANKING
```
    name of "ranking" parameter for specifying ranking criteria. The content depends on the used search engine.
    
    See Also:
    Constant Field Values
  - RESULTATTRIBUTES
```
public static final java.lang.String RESULTATTRIBUTES
```
    name of the "resultAttributes" parameter.
    
    See Also:
    Constant Field Values
  - SORTBY
```
public static final java.lang.String SORTBY
```
    name of the "sortby" parameter subparameters.
    
    See Also:
    Constant Field Values
  - ATTRIBUTE
```
public static final java.lang.String ATTRIBUTE
```
    name of the "attribute" parameter of an "sortby" or "facetby" parameter.
    
    See Also:
    Constant Field Values
  - ORDER
```
public static final java.lang.String ORDER
```
    name of the "order" parameter of an "sortby" or "facetby" parameter.
    
    See Also:
    Constant Field Values
  - NATIVE_PARAMETERS
```
public static final java.lang.String NATIVE_PARAMETERS
```
    name of a nested map to hold arbitrary parameters native to the underlying search technology.
    
    See Also:
    Constant Field Values
  - FILTER
```
public static final java.lang.String FILTER
```
    name of "filter" parameter.
    
    See Also:
    Constant Field Values
  - FILTER_ALLOF
```
public static final java.lang.String FILTER_ALLOF
```
    See Also:
    Constant Field Values
  - FILTER_ONEOF
```
public static final java.lang.String FILTER_ONEOF
```
    at least one of the given values must match.
    
    See Also:
    Constant Field Values
  - FILTER_NONEOF
```
public static final java.lang.String FILTER_NONEOF
```
    See Also:
    Constant Field Values
  - FILTER_ATLEAST
```
public static final java.lang.String FILTER_ATLEAST
```
    See Also:
    Constant Field Values
  - FILTER_ATMOST
```
public static final java.lang.String FILTER_ATMOST
```
    See Also:
    Constant Field Values
  - FILTER_GREATERTHAN
```
public static final java.lang.String FILTER_GREATERTHAN
```
    See Also:
    Constant Field Values
  - FILTER_LESSTHAN
```
public static final java.lang.String FILTER_LESSTHAN
```
    See Also:
    Constant Field Values
  - DEFAULT_MAXCOUNT
```
public static final int DEFAULT_MAXCOUNT
```
    default "resultSize" value: 10.
    
    See Also:
    Constant Field Values
  - DEFAULT_OFFSET
```
public static final int DEFAULT_OFFSET
```
    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
  - GROUPBY
```
public static final java.lang.String GROUPBY
```
    GROUPBY
    
    See Also:
    Constant Field Values
  - GROUPBY_AS_MAIN_RESULT
```
public static final java.lang.String GROUPBY_AS_MAIN_RESULT
```
    GROUPBY_AS_MAIN_RESULT
    
    See Also:
    Constant Field Values

Class QueryConstants

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUERY

MAXCOUNT

OFFSET

THRESHOLD

LANGUAGE

INDEXNAME

HIGHLIGHT

FACETBY

FACETBY_SORTCRITERION

RANKING

RESULTATTRIBUTES

SORTBY

ATTRIBUTE

ORDER

NATIVE_PARAMETERS

FILTER

FILTER_ALLOF

FILTER_ONEOF

FILTER_NONEOF

FILTER_ATLEAST

FILTER_ATMOST

FILTER_GREATERTHAN

FILTER_LESSTHAN

DEFAULT_MAXCOUNT

DEFAULT_OFFSET

DEFAULT_THRESHOLD

GROUPBY

GROUPBY_AS_MAIN_RESULT