org.elasticsearch.search.internal

Class InternalSearchHits

java.lang.Object

org.elasticsearch.search.internal.InternalSearchHits

All Implemented Interfaces:

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

public class InternalSearchHits
extends java.lang.Object
implements SearchHits

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalSearchHits.StreamContext

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 InternalSearchHit[]	EMPTY
long	totalHits

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalSearchHits(InternalSearchHit[] hits, long totalHits, float maxScore)

Method Summary

Modifier and Type	Method and Description
static InternalSearchHits	empty()
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() The hits of the search request (based on the search type, and from / size provided).
InternalSearchHit[]	internalHits()
java.util.Iterator<SearchHit>	iterator()
float	maxScore() The maximum score of this query.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
void	readFrom(StreamInput in, InternalSearchHits.StreamContext context)
static InternalSearchHits	readSearchHits(StreamInput in)
static InternalSearchHits	readSearchHits(StreamInput in, InternalSearchHits.StreamContext context)
void	shardTarget(SearchShardTarget shardTarget)
static InternalSearchHits.StreamContext	streamContext()
long	totalHits() The total number of hits that matches the search request.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.
void	writeTo(StreamOutput out, InternalSearchHits.StreamContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY

public static final InternalSearchHit[] EMPTY

totalHits

public long totalHits

Constructor Detail

InternalSearchHits

public InternalSearchHits(InternalSearchHit[] hits,
                          long totalHits,
                          float maxScore)

Method Detail

streamContext

public static InternalSearchHits.StreamContext streamContext()

empty

public static InternalSearchHits empty()

shardTarget

public void shardTarget(SearchShardTarget shardTarget)

totalHits

public long totalHits()

Description copied from interface: SearchHits

The total number of hits that matches the search request.

Specified by:

totalHits in interface SearchHits

getTotalHits

public long getTotalHits()

Description copied from interface: SearchHits

The total number of hits that matches the search request.

Specified by:

getTotalHits in interface SearchHits

maxScore

public float maxScore()

Description copied from interface: SearchHits

The maximum score of this query.

Specified by:

maxScore in interface SearchHits

getMaxScore

public float getMaxScore()

Description copied from interface: SearchHits

The maximum score of this query.

Specified by:

getMaxScore in interface SearchHits

hits

public SearchHit[] hits()

Description copied from interface: SearchHits

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

Specified by:

hits in interface SearchHits

getAt

public SearchHit getAt(int position)

Description copied from interface: SearchHits

Return the hit as the provided position.

Specified by:

getAt in interface SearchHits

getHits

public SearchHit[] getHits()

Description copied from interface: SearchHits

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

Specified by:

getHits in interface SearchHits

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SearchHit>

internalHits

public InternalSearchHit[] internalHits()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

readSearchHits

public static InternalSearchHits readSearchHits(StreamInput in,
                                                InternalSearchHits.StreamContext context)
                                         throws java.io.IOException

Throws:

java.io.IOException

readSearchHits

public static InternalSearchHits 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

readFrom

public void readFrom(StreamInput in,
                     InternalSearchHits.StreamContext context)
              throws java.io.IOException

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

writeTo

public void writeTo(StreamOutput out,
                    InternalSearchHits.StreamContext context)
             throws java.io.IOException

Throws:

java.io.IOException