Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Class InternalCentroid

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.metrics.InternalCentroid

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, CentroidAggregation, ToXContent, ToXContentFragment

Direct Known Subclasses:

InternalGeoCentroid

public abstract class InternalCentroid
extends InternalAggregation
implements CentroidAggregation

Serialization and merge logic for GeoCentroidAggregator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalCentroid.Fields
static final record	InternalCentroid.ShapeData	Holds the raw weighted sums and dimensional shape type needed for correct cross-shard reduction of shape centroids.

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

Aggregation.CommonFields

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
protected final SpatialPoint	centroid
protected final long	count
protected final InternalCentroid.ShapeData	shapeData

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.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	InternalCentroid(String name, SpatialPoint centroid, long count, Map<String,Object> metadata)
	InternalCentroid(String name, SpatialPoint centroid, long count, InternalCentroid.ShapeData shapeData, Map<String,Object> metadata)
protected	InternalCentroid(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
SpatialPoint	centroid()
protected abstract SpatialPoint	centroidFromStream(StreamInput in)
protected abstract void	centroidToStream(StreamOutput out)
protected abstract InternalCentroid	copyWith(double firstSum, double secondSum, long totalCount)	Create a new centroid by reducing from the sums and total count (count-weighted path for geo_point).
protected abstract InternalCentroid	copyWith(SpatialPoint result, long count)
protected abstract InternalCentroid	copyWithShapeFields(InternalCentroid.ShapeData shapeData, long count)	Create a new centroid from shape-aware weighted sums (area-weighted path for geo_shape).
long	count()
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
protected abstract double	extractDouble(String name)
protected abstract double	extractFirst(SpatialPoint point)
protected abstract double	extractSecond(SpatialPoint point)
InternalAggregation	finalizeSampling(SamplingContext samplingContext)	Called by the parent sampling context.
protected AggregatorReducer	getLeaderReducer(AggregationReduceContext reduceContext, int size)	Return an object that Reduces several aggregations to a single one.
Object	getProperty(List<String> path)
int	hashCode()
protected boolean	mustReduceOnSingleInternalAgg()	Signal the framework if the AggregatorReducer phase needs to be called when there is only one InternalAggregation.
protected abstract String	nameFirst()
protected abstract String	nameSecond()
String	toString()

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

canLeadReduction, copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getReducer, getType, readSize, reducePipelines, sortValue, sortValue, 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.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

centroid

protected final SpatialPoint centroid

count

protected final long count

shapeData

protected final InternalCentroid.ShapeData shapeData

Constructor Details

InternalCentroid

public InternalCentroid(String name,
 SpatialPoint centroid,
 long count,
 Map<String,Object> metadata)

InternalCentroid

public InternalCentroid(String name,
 SpatialPoint centroid,
 long count,
 InternalCentroid.ShapeData shapeData,
 Map<String,Object> metadata)

InternalCentroid

protected InternalCentroid(StreamInput in)
                    throws IOException

Read from a stream.

Throws:

IOException

Method Details

centroidFromStream

protected abstract SpatialPoint centroidFromStream(StreamInput in)
                                            throws IOException

Throws:

IOException

centroidToStream

protected abstract void centroidToStream(StreamOutput out)
                                  throws IOException

Throws:

IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

centroid

public SpatialPoint centroid()

Specified by:

centroid in interface CentroidAggregation

count

public long count()

Specified by:

count in interface CentroidAggregation

copyWith

protected abstract InternalCentroid copyWith(SpatialPoint result,
 long count)

copyWith

protected abstract InternalCentroid copyWith(double firstSum,
 double secondSum,
 long totalCount)

Create a new centroid by reducing from the sums and total count (count-weighted path for geo_point).

copyWithShapeFields

protected abstract InternalCentroid copyWithShapeFields(InternalCentroid.ShapeData shapeData,
 long count)

Create a new centroid from shape-aware weighted sums (area-weighted path for geo_shape).

getLeaderReducer

protected AggregatorReducer getLeaderReducer(AggregationReduceContext reduceContext,
 int size)

Description copied from class: InternalAggregation

Return an object that Reduces several aggregations to a single one. This method is called when InternalAggregation.canLeadReduction() returns true and expects an reducer that produces the right result.

Specified by:

getLeaderReducer in class InternalAggregation

nameFirst

protected abstract String nameFirst()

extractFirst

protected abstract double extractFirst(SpatialPoint point)

nameSecond

protected abstract String nameSecond()

extractSecond

protected abstract double extractSecond(SpatialPoint point)

finalizeSampling

public InternalAggregation finalizeSampling(SamplingContext samplingContext)

Description copied from class: InternalAggregation

Called by the parent sampling context. Should only ever be called once as some aggregations scale their internal values

Overrides:

finalizeSampling in class InternalAggregation

Parameters:

samplingContext - the current sampling context

Returns:

new aggregation with the sampling context applied, could be the same aggregation instance if nothing needs to be done

mustReduceOnSingleInternalAgg

protected boolean mustReduceOnSingleInternalAgg()

Description copied from class: InternalAggregation

Signal the framework if the AggregatorReducer phase needs to be called when there is only one InternalAggregation.

Specified by:

mustReduceOnSingleInternalAgg in class InternalAggregation

extractDouble

protected abstract double extractDouble(String name)

getProperty

public Object getProperty(List<String> path)

Specified by:

getProperty in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation

toString

public String toString()

Overrides:

toString in class InternalAggregation