Class Results
- java.lang.Object
-
- com.lucidworks.search.dsl.DslBase
-
- com.lucidworks.search.dsl.request.DslCloneable
-
- com.lucidworks.search.dsl.request.Results
-
public class Results extends DslCloneable
Search results parametersgetCursor()
andgetStart()
are mutually exclusive
-
-
Constructor Summary
Constructors Constructor Description Results(java.lang.String cursor, java.lang.Long start, java.lang.Long size, java.util.List<SortElement> sort, java.util.Collection<java.lang.String> fields, Highlight highlight, java.lang.Boolean returnScore, java.lang.Boolean includeRawResponse, Group group, java.lang.Boolean spellcheck)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Results
clone()
java.lang.String
getCursor()
java.util.Collection<java.lang.String>
getFields()
Group
getGroup()
Highlight
getHighlight()
java.lang.Boolean
getIncludeRawResponse()
java.lang.Long
getSize()
java.util.List<SortElement>
getSort()
java.lang.Long
getStart()
java.lang.Boolean
isReturnScore()
java.lang.Boolean
isSpellcheck()
void
setCursor(java.lang.String cursor)
void
setFields(java.util.Collection<java.lang.String> fields)
void
setGroup(Group group)
void
setHighlight(Highlight highlight)
void
setReturnScore(boolean returnScore)
void
setSize(long size)
void
setSort(java.util.List<? extends SortElement> sort)
void
setSpellcheck(java.lang.Boolean spellcheck)
void
setStart(java.lang.Long start)
-
Methods inherited from class com.lucidworks.search.dsl.request.DslCloneable
clone, deepClone
-
-
-
-
Constructor Detail
-
Results
public Results(java.lang.String cursor, java.lang.Long start, java.lang.Long size, java.util.List<SortElement> sort, java.util.Collection<java.lang.String> fields, Highlight highlight, java.lang.Boolean returnScore, java.lang.Boolean includeRawResponse, Group group, java.lang.Boolean spellcheck)
-
-
Method Detail
-
getCursor
public java.lang.String getCursor()
- Returns:
- cursor. Use
Pagination.getCursor()
from previous response to continue
-
getSize
public java.lang.Long getSize()
- Returns:
- max number of documents to return
-
getSort
public java.util.List<SortElement> getSort()
- Returns:
- sort order of search result
-
setCursor
public void setCursor(java.lang.String cursor)
-
setSize
public void setSize(long size)
-
getFields
public java.util.Collection<java.lang.String> getFields()
- Returns:
- document fields to be included into search result
-
setFields
public void setFields(java.util.Collection<java.lang.String> fields)
-
getHighlight
public Highlight getHighlight()
- Returns:
- results highlight parameters
-
setHighlight
public void setHighlight(Highlight highlight)
-
isReturnScore
public java.lang.Boolean isReturnScore()
- Returns:
- include score with results
-
setReturnScore
public void setReturnScore(boolean returnScore)
-
setSort
public void setSort(java.util.List<? extends SortElement> sort)
-
getStart
public java.lang.Long getStart()
- Returns:
- starting offset for documents in result
-
setStart
public void setStart(java.lang.Long start)
-
getIncludeRawResponse
public java.lang.Boolean getIncludeRawResponse()
- Returns:
- include search engine response json
-
getGroup
public Group getGroup()
- Returns:
- results grouping parameters
-
setGroup
public void setGroup(Group group)
-
isSpellcheck
public java.lang.Boolean isSpellcheck()
- Returns:
- perform spellcheck on the userQuery
-
setSpellcheck
public void setSpellcheck(java.lang.Boolean spellcheck)
-
clone
public Results clone()
- Specified by:
clone
in classDslCloneable
-
-