Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.action.util

Class QueryPage<T extends ToXContent & Writeable>

java.lang.Object

org.elasticsearch.xpack.core.action.util.QueryPage<T>

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public final class QueryPage<T extends ToXContent & Writeable>
extends Object
implements ToXContentObject, Writeable

Generic wrapper class for a page of query results and the total number of query results.
count() is the total number of results but that value may not be equal to the actual length of the results() list if from & take or some cursor was used in the database query.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.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 final ParseField	COUNT
static final ParseField	DEFAULT_RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
QueryPage(List<T> results, long count, ParseField resultsField)
QueryPage(StreamInput in, Writeable.Reader<T> hitReader)

Method Summary

Modifier and Type	Method	Description
long	count()
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
static ResourceNotFoundException	emptyQueryPage(ParseField resultsField)
boolean	equals(Object obj)
ParseField	getResultsField()
int	hashCode()
List<T>	results()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

COUNT

public static final ParseField COUNT

DEFAULT_RESULTS_FIELD

public static final ParseField DEFAULT_RESULTS_FIELD

Constructor Details

QueryPage

public QueryPage(List<T> results,
 long count,
 ParseField resultsField)

QueryPage

public QueryPage(StreamInput in,
 Writeable.Reader<T> hitReader)
          throws IOException

Throws:

IOException

Method Details

emptyQueryPage

public static ResourceNotFoundException emptyQueryPage(ParseField resultsField)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

doXContentBody

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

Throws:

IOException

results

public List<T> results()

count

public long count()

getResultsField

public ParseField getResultsField()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object