org.elasticsearch.search.aggregations.metrics.tophits

Class InternalTopHits

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.metrics.tophits.InternalTopHits

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, Aggregation, TopHits

public class InternalTopHits
extends InternalAggregation
implements TopHits

Results of the TopHitsAggregator.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

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 inherited from class org.elasticsearch.search.aggregations.InternalAggregation

metaData, name

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalTopHits(StreamInput in) Read from a stream.
InternalTopHits(java.lang.String name, int from, int size, org.apache.lucene.search.TopDocs topDocs, SearchHits searchHits, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(java.lang.Object obj) Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class.
protected int	doHashCode() Opportunity for subclasses to the InternalAggregation.hashCode() for this class.
InternalAggregation	doReduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
SearchHits	getHits()
java.lang.Object	getProperty(java.util.List<java.lang.String> path)
java.lang.String	getWriteableName() Returns the name of the writeable object

Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation

equals, getMetaData, getName, getProperty, getType, hashCode, pipelineAggregators, readSize, reduce, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetaData, getName, getType

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

isFragment

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

toXContent

Constructor Detail

InternalTopHits

public InternalTopHits(java.lang.String name,
                       int from,
                       int size,
                       org.apache.lucene.search.TopDocs topDocs,
                       SearchHits searchHits,
                       java.util.List<PipelineAggregator> pipelineAggregators,
                       java.util.Map<java.lang.String,java.lang.Object> metaData)

InternalTopHits

public InternalTopHits(StreamInput in)
                throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

getHits

public SearchHits getHits()

Specified by:

getHits in interface TopHits

Returns:

The top matching hits for the bucket

doReduce

public InternalAggregation doReduce(java.util.List<InternalAggregation> aggregations,
                                    InternalAggregation.ReduceContext reduceContext)

Specified by:

doReduce in class InternalAggregation

getProperty

public java.lang.Object getProperty(java.util.List<java.lang.String> path)

Specified by:

getProperty in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException

doEquals

protected boolean doEquals(java.lang.Object obj)

Description copied from class: InternalAggregation

Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class. This method can safely cast obj to the subclass since the InternalAggregation.equals(Object) method checks that obj is the same class as this

Specified by:

doEquals in class InternalAggregation

doHashCode

protected int doHashCode()

Description copied from class: InternalAggregation

Opportunity for subclasses to the InternalAggregation.hashCode() for this class.

Specified by:

doHashCode in class InternalAggregation