de.julielab.elastic.query.components.data

Class SearchServerCommand

java.lang.Object

de.julielab.elastic.query.components.data.SearchServerCommand

public class SearchServerCommand
extends Object

Author:

faessler

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,AggregationCommand>	aggregationCmds
boolean	downloadCompleteResults Causes the return of all results of the query, not only a page or a batch.
boolean	fetchSource For multi-field queries, provided the fields that should be queried on using #serverQuery.
List<String>	fieldsToReturn The fields for which their original content should be returned.
boolean	filterReviews
List<HighlightCommand>	hlCmds
String	index The index to perform the search on.
Collection<String>	indexTypes
int	limit Specifies a limit of documents to retrieve for this search.
Map<String,SearchServerQuery>	namedQueries Maps a name to a query for easy access, e.g.
SearchServerQuery	postFilterQuery
SearchServerQuery	query A structured search server query.
int	rows The value Integer.MIN_VALUE means "not set".
List<SortCommand>	sortCmds
int	start
Map<String,List<String>>	suggestionCategories For some suggester types, e.g.
String	suggestionField The field for which to get suggestions.
String	suggestionText For auto completion, this field exposes the fragment to get suggestions for.

Constructor Summary

Constructors

Constructor and Description
SearchServerCommand()

Method Summary

Modifier and Type	Method and Description
void	addAggregationCommand(AggregationCommand aggCmd)
void	addField(String field)
void	addHighlightCmd(HighlightCommand hlc)
void	addSortCommand(String field, SortCommand.SortOrder order)

Methods inherited from class java.lang.Object

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

Field Detail

query

public SearchServerQuery query

A structured search server query. The actual query instance is a subclass of SearchServerQuery. This object has to be cast to its actual class and does then expose all properties of the server query.

See Also:

SearchServerQuery

suggestionText

public String suggestionText

For auto completion, this field exposes the fragment to get suggestions for.

suggestionField

public String suggestionField

The field for which to get suggestions.

suggestionCategories

public Map<String,List<String>> suggestionCategories

For some suggester types, e.g. completion suggester: The suggestion categories.

start

public int start

rows

public int rows

The value Integer.MIN_VALUE means "not set".

fieldsToReturn

public List<String> fieldsToReturn

The fields for which their original content should be returned. Does only work for stored fields, of course. A null value (default) causes all fields to be returned. To return no fields, set an empty list.

fetchSource

public boolean fetchSource

For multi-field queries, provided the fields that should be queried on using #serverQuery. The * wildcard is allowed for the field names.

aggregationCmds

public Map<String,AggregationCommand> aggregationCmds

hlCmds

public List<HighlightCommand> hlCmds

filterReviews

public boolean filterReviews

sortCmds

public List<SortCommand> sortCmds

index

public String index

The index to perform the search on.

limit

public int limit

Specifies a limit of documents to retrieve for this search.

namedQueries

public Map<String,SearchServerQuery> namedQueries

Maps a name to a query for easy access, e.g. for highlighting. Specific (sub-)queries may be stored in this map.

postFilterQuery

public SearchServerQuery postFilterQuery

indexTypes

public Collection<String> indexTypes

downloadCompleteResults

public boolean downloadCompleteResults

Causes the return of all results of the query, not only a page or a batch. May require additional requests to the server which are automatically done by the ElasticSearchServerResponse.getDocumentResults().

Constructor Detail

SearchServerCommand

public SearchServerCommand()

Method Detail

addField

public void addField(String field)

addHighlightCmd

public void addHighlightCmd(HighlightCommand hlc)

Parameters:

hlc -

addSortCommand

public void addSortCommand(String field,
                           SortCommand.SortOrder order)

addAggregationCommand

public void addAggregationCommand(AggregationCommand aggCmd)