com.eurodyn.qlack.fuse.search.dto.queries

Class QuerySpec

java.lang.Object

com.eurodyn.qlack.fuse.search.dto.queries.QuerySpec

Direct Known Subclasses:

QueryBoolean, QueryExists, QueryExistsNested, QueryMatch, QueryMultiMatch, QueryRange, QueryString, QueryStringSpecField, QueryStringSpecFieldNested, QueryTerm, QueryTermNested, QueryTerms, QueryTermsNested, QueryWildcard, QueryWildcardNested, SimpleQueryString

public abstract class QuerySpec
extends Object

The superclass of all different types of queries supported by this module. It provides commonly used properties between all subclasses as well as it allows to tune the number and type of search results.

Field Summary

Fields

Modifier and Type	Field and Description
protected QuerySort	querySort

Constructor Summary

Constructors

Constructor and Description
QuerySpec()

Method Summary

Modifier and Type	Method and Description
QuerySpec	exclude(String exclude)
QuerySpec	excludeResults() Convenience method to exclude search hitList from the results.
QuerySpec	include(String include)
QuerySpec	includeAllSources() Convenience method to include the complete query output in the results.
QuerySpec	setAggregate(String aggregate) Convenience method that sets the current aggregate
QuerySpec	setAggregateSize(int aggregateSize) Convenience method that sets the aggregate size
QuerySpec	setCountOnly(boolean countOnly) Convenience method that sets a flag to include only result count
QuerySpec	setExplain(boolean explain) Sets whether ES explain info is included in the results.
QuerySpec	setHighlight(QueryHighlight highlight)
QuerySpec	setIndex(String... indexName) Sets the indices against which the query is executed.
QuerySpec	setInnerHits(InnerHits innerHits)
QuerySpec	setPageSize(int pageSize) Sets the number of search results returned.
QuerySpec	setQuerySort(QuerySort querySort) Convenience method to include a query sort object
QuerySpec	setScroll(Integer scroll) Convenience method that sets the current scroll
QuerySpec	setStartRecord(int startRecord) Sets the first record from which search results are paginated.
QuerySpec	setType(String... typeName) Sets the document types against which the query is executed.

Methods inherited from class java.lang.Object

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

Field Detail

querySort

protected QuerySort querySort

Constructor Detail

QuerySpec

public QuerySpec()

Method Detail

setIndex

public QuerySpec setIndex(String... indexName)

Sets the indices against which the query is executed.

Parameters:

indexName - The names of the indices to add.

Returns:

a QuerySpec object

setType

public QuerySpec setType(String... typeName)

Sets the document types against which the query is executed.

Parameters:

typeName - The names of the document types to search.

Returns:

a QuerySpec object

setStartRecord

public QuerySpec setStartRecord(int startRecord)

Sets the first record from which search results are paginated.

Parameters:

startRecord - The number of record to start from.

Returns:

a QuerySpec object

setPageSize

public QuerySpec setPageSize(int pageSize)

Sets the number of search results returned.

Parameters:

pageSize - The number of results to return.

Returns:

a QuerySpec object

setExplain

public QuerySpec setExplain(boolean explain)

Sets whether ES explain info is included in the results.

Parameters:

explain - Whether to enable or disable the ES explain info.

Returns:

a QuerySpec object

includeAllSources

public QuerySpec includeAllSources()

Convenience method to include the complete query output in the results.

Returns:

a QuerySpec object

excludeResults

public QuerySpec excludeResults()

Convenience method to exclude search hitList from the results.

Returns:

a QuerySpec object

setQuerySort

public QuerySpec setQuerySort(QuerySort querySort)

Convenience method to include a query sort object

Parameters:

querySort - the query sort object

Returns:

a QuerySpec object

setCountOnly

public QuerySpec setCountOnly(boolean countOnly)

Convenience method that sets a flag to include only result count

Parameters:

countOnly - the flag

Returns:

a QuerySpec object

setScroll

public QuerySpec setScroll(Integer scroll)

Convenience method that sets the current scroll

Parameters:

scroll - the scroll

Returns:

a QuerySpec object

setAggregate

public QuerySpec setAggregate(String aggregate)

Convenience method that sets the current aggregate

Parameters:

aggregate - the aggregate

Returns:

a QuerySpec object

setAggregateSize

public QuerySpec setAggregateSize(int aggregateSize)

Convenience method that sets the aggregate size

Parameters:

aggregateSize - the aggregate size

Returns:

a QuerySpec object

include

public QuerySpec include(String include)

exclude

public QuerySpec exclude(String exclude)

setHighlight

public QuerySpec setHighlight(QueryHighlight highlight)

setInnerHits

public QuerySpec setInnerHits(InnerHits innerHits)