Package org.elasticsearch.search

Class SearchHits

java.lang.Object

org.elasticsearch.search.SearchHits

All Implemented Interfaces:

Iterable<SearchHit>, Writeable, ToXContent, ToXContentFragment

public final class SearchHits
extends Object
implements Writeable, ToXContentFragment, Iterable<SearchHit>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchHits.Fields

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static SearchHit[]	EMPTY

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchHits(StreamInput in)
SearchHits(SearchHit[] hits, TotalHits totalHits, float maxScore)
SearchHits(SearchHit[] hits, TotalHits totalHits, float maxScore, SortField[] sortFields, String collapseField, Object[] collapseValues)

Method Summary

Modifier and Type	Method	Description
static SearchHits	empty()
static SearchHits	empty(boolean withTotalHits)
boolean	equals(Object obj)
static SearchHits	fromXContent(XContentParser parser)
SearchHit	getAt(int position)	Return the hit as the provided position.
String	getCollapseField()	In case field collapsing was performed, returns the field used for field collapsing, null otherwise
Object[]	getCollapseValues()	In case field collapsing was performed, returns the values of the field that field collapsing was performed on, null otherwise
SearchHit[]	getHits()	The hits of the search request (based on the search type, and from / size provided).
float	getMaxScore()	The maximum score of this query.
SortField[]	getSortFields()	In case documents were sorted by field(s), returns information about such field(s), null otherwise
TotalHits	getTotalHits()	The total number of hits for the query or null if the tracking of total hits is disabled in the request.
int	hashCode()
Iterator<SearchHit>	iterator()
static TotalHits	parseTotalHitsFragment(XContentParser parser)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

EMPTY

public static final SearchHit[] EMPTY

Constructor Detail

SearchHits

public SearchHits(SearchHit[] hits,
                  @Nullable
                  TotalHits totalHits,
                  float maxScore)

SearchHits

public SearchHits(SearchHit[] hits,
                  @Nullable
                  TotalHits totalHits,
                  float maxScore,
                  @Nullable
                  SortField[] sortFields,
                  @Nullable
                  String collapseField,
                  @Nullable
                  Object[] collapseValues)

SearchHits

public SearchHits(StreamInput in)
           throws IOException

Throws:

IOException

Method Detail

empty

public static SearchHits empty()

empty

public static SearchHits empty(boolean withTotalHits)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getTotalHits

@Nullable
public TotalHits getTotalHits()

The total number of hits for the query or null if the tracking of total hits is disabled in the request.

getMaxScore

public float getMaxScore()

The maximum score of this query.

getHits

public SearchHit[] getHits()

The hits of the search request (based on the search type, and from / size provided).

getAt

public SearchHit getAt(int position)

Return the hit as the provided position.

getSortFields

@Nullable
public SortField[] getSortFields()

In case documents were sorted by field(s), returns information about such field(s), null otherwise

See Also:

SortField

getCollapseField

@Nullable
public String getCollapseField()

In case field collapsing was performed, returns the field used for field collapsing, null otherwise

getCollapseValues

@Nullable
public Object[] getCollapseValues()

In case field collapsing was performed, returns the values of the field that field collapsing was performed on, null otherwise

iterator

public Iterator<SearchHit> iterator()

Specified by:

iterator in interface Iterable<SearchHit>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static SearchHits fromXContent(XContentParser parser)
                               throws IOException

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

parseTotalHitsFragment

public static TotalHits parseTotalHitsFragment(XContentParser parser)
                                        throws IOException

Throws:

IOException