Package org.elasticsearch.search

Class SearchHits

java.lang.Object

org.elasticsearch.search.SearchHits

All Implemented Interfaces:

java.lang.Iterable<SearchHit>, Streamable, ToXContent, ToXContentFragment

public final class SearchHits
extends java.lang.Object
implements Streamable, ToXContentFragment, java.lang.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

Field Summary

Fields

Modifier and Type	Field	Description
static SearchHit[]	EMPTY
long	totalHits

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchHits(SearchHit[] hits, long totalHits, float maxScore)
SearchHits(SearchHit[] hits, long totalHits, float maxScore, org.apache.lucene.search.SortField[] sortFields, java.lang.String collapseField, java.lang.Object[] collapseValues)

Method Summary

Modifier and Type	Method	Description
static SearchHits	empty()
boolean	equals(java.lang.Object obj)
static SearchHits	fromXContent(XContentParser parser)
SearchHit	getAt(int position)	Return the hit as the provided position.
java.lang.String	getCollapseField()	In case field collapsing was performed, returns the field used for field collapsing, null otherwise
java.lang.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.
org.apache.lucene.search.SortField[]	getSortFields()	In case documents were sorted by field(s), returns information about such field(s), null otherwise
long	getTotalHits()	The total number of hits that matches the search request.
int	hashCode()
java.util.Iterator<SearchHit>	iterator()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
static SearchHits	readSearchHits(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this object's fields to a 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

totalHits

public long totalHits

Constructor Detail

SearchHits

public SearchHits(SearchHit[] hits,
                  long totalHits,
                  float maxScore)

SearchHits

public SearchHits(SearchHit[] hits,
                  long totalHits,
                  float maxScore,
                  @Nullable
                  org.apache.lucene.search.SortField[] sortFields,
                  @Nullable
                  java.lang.String collapseField,
                  @Nullable
                  java.lang.Object[] collapseValues)

Method Detail

empty

public static SearchHits empty()

getTotalHits

public long getTotalHits()

The total number of hits that matches the search 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 org.apache.lucene.search.SortField[] getSortFields()

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

See Also:

SortField

getCollapseField

@Nullable
public java.lang.String getCollapseField()

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

getCollapseValues

@Nullable
public java.lang.Object[] getCollapseValues()

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

iterator

public java.util.Iterator<SearchHit> iterator()

Specified by:

iterator in interface java.lang.Iterable<SearchHit>

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public static SearchHits fromXContent(XContentParser parser)
                               throws java.io.IOException

Throws:

java.io.IOException

readSearchHits

public static SearchHits readSearchHits(StreamInput in)
                                 throws java.io.IOException

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object