Module org.elasticsearch.compute

Package org.elasticsearch.compute.operator.topn

Class SharedMinCompetitive

java.lang.Object

org.elasticsearch.core.AbstractRefCounted

org.elasticsearch.compute.operator.SideChannel

org.elasticsearch.compute.operator.topn.SharedMinCompetitive

All Implemented Interfaces:

Closeable, AutoCloseable, org.elasticsearch.core.RefCounted, org.elasticsearch.core.Releasable

public class SharedMinCompetitive
extends SideChannel

A thread safe, shared holder for the min competitive value from a set of TopNOperators.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SharedMinCompetitive.KeyConfig
static class	SharedMinCompetitive.Supplier

Nested classes/interfaces inherited from class org.elasticsearch.compute.operator.SideChannel

SideChannel.Status

Field Summary

Fields inherited from class org.elasticsearch.core.AbstractRefCounted

ALREADY_CLOSED_MESSAGE, INVALID_DECREF_MESSAGE

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Method Summary

Modifier and Type	Method	Description
protected void	closeSideChannel()
List<SharedMinCompetitive.KeyConfig>	configs()
Page	get(BlockFactory blockFactory)	Read the min competitive value.
boolean	offer(org.apache.lucene.util.BytesRef minCompetitive)	Offer an update to the min competitive value.

Methods inherited from class org.elasticsearch.compute.operator.SideChannel

close, closeInternal

Methods inherited from class org.elasticsearch.core.AbstractRefCounted

alreadyClosed, decRef, hasReferences, incRef, mustIncRef, of, refCount, touch, tryIncRef

Methods inherited from class java.lang.Object

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

Method Details

configs

public List<SharedMinCompetitive.KeyConfig> configs()

offer

public boolean offer(org.apache.lucene.util.BytesRef minCompetitive)

Offer an update to the min competitive value.

Parameters:

minCompetitive - if it is accepted then the bytes are copied

Returns:

whether the update was accepted. false here means the minimum value in the local top n is greater than or equal to the minimum competitive value already recorded

get

@Nullable
public Page get(BlockFactory blockFactory)

Read the min competitive value. This will return null if there isn't yet a min competitive value. Otherwise, this will return a Page that contains single-position, single-valued Blocks.

closeSideChannel

protected void closeSideChannel()

Specified by:

closeSideChannel in class SideChannel