org.elasticsearch.search

Class SearchHits

java.lang.Object

org.elasticsearch.search.SearchHits

All Implemented Interfaces:

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

public class SearchHits
extends java.lang.Object
implements Streamable, ToXContent, java.lang.Iterable<SearchHit>

The hits of a search request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 and Description
static SearchHit[]	EMPTY
long	totalHits

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SearchHits(SearchHit[] hits, long totalHits, float maxScore)

Method Summary

Modifier and Type	Method and Description
static SearchHits	empty()
static SearchHits	fromXContent(XContentParser parser)
SearchHit	getAt(int position) Return the hit as the provided position.
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.
long	getTotalHits() The total number of hits that matches the search request.
SearchHit[]	hits() Deprecated. use getHits() instead
SearchHit[]	internalHits()
java.util.Iterator<SearchHit>	iterator()
float	maxScore() Deprecated. use getMaxScore() instead
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
static SearchHits	readSearchHits(StreamInput in)
long	totalHits() Deprecated. use getTotalHits() instead
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isFragment

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY

public static final SearchHit[] EMPTY

totalHits

public long totalHits

Constructor Detail

SearchHits

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

Method Detail

empty

public static SearchHits empty()

totalHits

@Deprecated
public long totalHits()

Deprecated. use getTotalHits() instead

The total number of hits that matches the search request.

getTotalHits

public long getTotalHits()

The total number of hits that matches the search request.

maxScore

@Deprecated
public float maxScore()

Deprecated. use getMaxScore() instead

The maximum score of this query.

getMaxScore

public float getMaxScore()

The maximum score of this query.

hits

@Deprecated
public SearchHit[] hits()

Deprecated. use getHits() instead

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.

getHits

public SearchHit[] getHits()

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SearchHit>

internalHits

public SearchHit[] internalHits()

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