io.searchbox.core

Class SearchResult

java.lang.Object

io.searchbox.client.JestResult

io.searchbox.core.SearchResult

Direct Known Subclasses:

TopHitsAggregation

public class SearchResult
extends JestResult

Author:

cihat keser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SearchResult.Hit<T,K> Immutable class representing a search hit.

Nested classes/interfaces inherited from class io.searchbox.client.JestResult

JestResult.MetaField

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPLANATION_KEY
static String	HIGHLIGHT_KEY
static String[]	PATH_TO_MAX_SCORE
static String[]	PATH_TO_TOTAL
static String	SORT_KEY

Fields inherited from class io.searchbox.client.JestResult

errorMessage, ES_METADATA_ID, ES_METADATA_VERSION, gson, isSucceeded, jsonObject, jsonString, META_FIELDS, pathToResult, responseCode

Constructor Summary

Constructors

Constructor and Description
SearchResult(com.google.gson.Gson gson)
SearchResult(SearchResult searchResult)

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,List<String>>	extractHighlight(com.google.gson.JsonObject highlight)
protected <T,K> SearchResult.Hit<T,K>	extractHit(Class<T> sourceType, Class<K> explanationType, com.google.gson.JsonElement hitElement, String sourceKey)
protected List<String>	extractSort(com.google.gson.JsonArray sort)
MetricAggregation	getAggregations()
<T> SearchResult.Hit<T,Void>	getFirstHit(Class<T> sourceType)
<T,K> SearchResult.Hit<T,K>	getFirstHit(Class<T> sourceType, Class<K> explanationType)
<T> List<SearchResult.Hit<T,Void>>	getHits(Class<T> sourceType)
<T,K> List<SearchResult.Hit<T,K>>	getHits(Class<T> sourceType, Class<K> explanationType)
protected <T,K> List<SearchResult.Hit<T,K>>	getHits(Class<T> sourceType, Class<K> explanationType, boolean returnSingle)
Float	getMaxScore()
protected com.google.gson.JsonElement	getPath(String[] path)
<T> T	getSourceAsObject(Class<T> clazz) Deprecated.
<T> List<T>	getSourceAsObjectList(Class<T> type) Deprecated.
Integer	getTotal()

Methods inherited from class io.searchbox.client.JestResult

createSourceObject, extractSource, extractSource, getErrorMessage, getJsonMap, getJsonObject, getJsonString, getKeys, getPathToResult, getResponseCode, getSourceAsString, getSourceAsStringList, getValue, isSucceeded, setErrorMessage, setJsonMap, setJsonObject, setJsonString, setPathToResult, setResponseCode, setSucceeded

Methods inherited from class java.lang.Object

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

Field Detail

EXPLANATION_KEY

public static final String EXPLANATION_KEY

See Also:

Constant Field Values

HIGHLIGHT_KEY

public static final String HIGHLIGHT_KEY

See Also:

Constant Field Values

SORT_KEY

public static final String SORT_KEY

See Also:

Constant Field Values

PATH_TO_TOTAL

public static final String[] PATH_TO_TOTAL

PATH_TO_MAX_SCORE

public static final String[] PATH_TO_MAX_SCORE

Constructor Detail

SearchResult

public SearchResult(SearchResult searchResult)

SearchResult

public SearchResult(com.google.gson.Gson gson)

Method Detail

getSourceAsObject

@Deprecated
public <T> T getSourceAsObject(Class<T> clazz)

Deprecated.

Overrides:

getSourceAsObject in class JestResult

getSourceAsObjectList

@Deprecated
public <T> List<T> getSourceAsObjectList(Class<T> type)

Deprecated.

Overrides:

getSourceAsObjectList in class JestResult

getFirstHit

public <T> SearchResult.Hit<T,Void> getFirstHit(Class<T> sourceType)

getFirstHit

public <T,K> SearchResult.Hit<T,K> getFirstHit(Class<T> sourceType,
                                      Class<K> explanationType)

getHits

public <T> List<SearchResult.Hit<T,Void>> getHits(Class<T> sourceType)

getHits

public <T,K> List<SearchResult.Hit<T,K>> getHits(Class<T> sourceType,
                                        Class<K> explanationType)

getHits

protected <T,K> List<SearchResult.Hit<T,K>> getHits(Class<T> sourceType,
                                        Class<K> explanationType,
                                        boolean returnSingle)

extractHit

protected <T,K> SearchResult.Hit<T,K> extractHit(Class<T> sourceType,
                                     Class<K> explanationType,
                                     com.google.gson.JsonElement hitElement,
                                     String sourceKey)

extractSort

protected List<String> extractSort(com.google.gson.JsonArray sort)

extractHighlight

protected Map<String,List<String>> extractHighlight(com.google.gson.JsonObject highlight)

getTotal

public Integer getTotal()

getMaxScore

public Float getMaxScore()

getPath

protected com.google.gson.JsonElement getPath(String[] path)

getAggregations

public MetricAggregation getAggregations()