io.druid.query.aggregation.datasketches.quantiles

Class DoublesSketchMergeBufferAggregator

java.lang.Object

io.druid.query.aggregation.datasketches.quantiles.DoublesSketchMergeBufferAggregator

All Implemented Interfaces:

BufferAggregator, HotLoopCallee

public class DoublesSketchMergeBufferAggregator
extends Object
implements BufferAggregator

Constructor Summary

Constructors

Constructor and Description
DoublesSketchMergeBufferAggregator(ColumnValueSelector<com.yahoo.sketches.quantiles.DoublesSketch> selector, int k, int maxIntermediateSize)

Method Summary

Modifier and Type	Method and Description
void	aggregate(ByteBuffer buffer, int position) Aggregates metric values into the given aggregate byte representation Implementations of this method must read in the aggregate value from the buffer at the given position, aggregate the next element of data and write the updated aggregate value back into the buffer.
void	close() Release any resources used by the aggregator
Object	get(ByteBuffer buffer, int position) Returns the intermediate object representation of the given aggregate.
float	getFloat(ByteBuffer buffer, int position) Returns the float representation of the given aggregate byte array Converts the given byte buffer representation into the intermediate aggregate value.
long	getLong(ByteBuffer buffer, int position) Returns the long representation of the given aggregate byte array Converts the given byte buffer representation into the intermediate aggregate value.
void	init(ByteBuffer buffer, int position) Initializes the buffer location Implementations of this method must initialize the byte buffer at the given position Implementations must not change the position, limit or mark of the given buffer This method must not exceed the number of bytes returned by AggregatorFactory.getMaxIntermediateSize() in the corresponding AggregatorFactory
void	inspectRuntimeShape(RuntimeShapeInspector inspector) Implementations of this method should call inspector.visit() with all fields of this class, which meet two conditions: 1.
void	relocate(int oldPosition, int newPosition, ByteBuffer oldBuffer, ByteBuffer newBuffer) Relocates any cached objects.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.druid.query.aggregation.BufferAggregator

getDouble

Constructor Detail

DoublesSketchMergeBufferAggregator

public DoublesSketchMergeBufferAggregator(ColumnValueSelector<com.yahoo.sketches.quantiles.DoublesSketch> selector,
                                          int k,
                                          int maxIntermediateSize)

Method Detail

init

public void init(ByteBuffer buffer,
                 int position)

Description copied from interface: BufferAggregator

Initializes the buffer location Implementations of this method must initialize the byte buffer at the given position Implementations must not change the position, limit or mark of the given buffer This method must not exceed the number of bytes returned by AggregatorFactory.getMaxIntermediateSize() in the corresponding AggregatorFactory

Specified by:

init in interface BufferAggregator

Parameters:

buffer - byte buffer to initialize

position - offset within the byte buffer for initialization

aggregate

public void aggregate(ByteBuffer buffer,
                      int position)

Description copied from interface: BufferAggregator

Aggregates metric values into the given aggregate byte representation Implementations of this method must read in the aggregate value from the buffer at the given position, aggregate the next element of data and write the updated aggregate value back into the buffer. Implementations must not change the position, limit or mark of the given buffer

Specified by:

aggregate in interface BufferAggregator

Parameters:

buffer - byte buffer storing the byte array representation of the aggregate

position - offset within the byte buffer at which the current aggregate value is stored

get

public Object get(ByteBuffer buffer,
                  int position)

Description copied from interface: BufferAggregator

Returns the intermediate object representation of the given aggregate. Converts the given byte buffer representation into an intermediate aggregate Object Implementations must not change the position, limit or mark of the given buffer

Specified by:

get in interface BufferAggregator

Parameters:

buffer - byte buffer storing the byte array representation of the aggregate

position - offset within the byte buffer at which the aggregate value is stored

Returns:

the Object representation of the aggregate

getFloat

public float getFloat(ByteBuffer buffer,
                      int position)

Description copied from interface: BufferAggregator

Returns the float representation of the given aggregate byte array Converts the given byte buffer representation into the intermediate aggregate value. Implementations must not change the position, limit or mark of the given buffer Implementations are only required to support this method if they are aggregations which have an AggregatorFactory.getTypeName() of "float". If unimplemented, throwing an UnsupportedOperationException is common and recommended.

Specified by:

getFloat in interface BufferAggregator

Parameters:

buffer - byte buffer storing the byte array representation of the aggregate

position - offset within the byte buffer at which the aggregate value is stored

Returns:

the float representation of the aggregate

getLong

public long getLong(ByteBuffer buffer,
                    int position)

Description copied from interface: BufferAggregator

Returns the long representation of the given aggregate byte array Converts the given byte buffer representation into the intermediate aggregate value. Implementations must not change the position, limit or mark of the given buffer Implementations are only required to support this method if they are aggregations which have an AggregatorFactory.getTypeName() of "long". If unimplemented, throwing an UnsupportedOperationException is common and recommended.

Specified by:

getLong in interface BufferAggregator

Parameters:

buffer - byte buffer storing the byte array representation of the aggregate

position - offset within the byte buffer at which the aggregate value is stored

Returns:

the long representation of the aggregate

close

public void close()

Description copied from interface: BufferAggregator

Release any resources used by the aggregator

Specified by:

close in interface BufferAggregator

relocate

public void relocate(int oldPosition,
                     int newPosition,
                     ByteBuffer oldBuffer,
                     ByteBuffer newBuffer)

Description copied from interface: BufferAggregator

Relocates any cached objects. If underlying ByteBuffer used for aggregation buffer relocates to a new ByteBuffer, positional caches(if any) built on top of old ByteBuffer can not be used for further BufferAggregator.aggregate(ByteBuffer, int) calls. This method tells the BufferAggregator that the cached objects at a certain location has been relocated to a different location. Only used if there is any positional caches/objects in the BufferAggregator implementation. If relocate happens to be across multiple new ByteBuffers (say n ByteBuffers), this method should be called multiple times(n times) given all the new positions/old positions should exist in newBuffer/OldBuffer. Implementations must not change the position, limit or mark of the given buffer

Specified by:

relocate in interface BufferAggregator

Parameters:

oldPosition - old position of a cached object before aggregation buffer relocates to a new ByteBuffer.

newPosition - new position of a cached object after aggregation buffer relocates to a new ByteBuffer.

oldBuffer - old aggregation buffer.

newBuffer - new aggregation buffer.

inspectRuntimeShape

public void inspectRuntimeShape(RuntimeShapeInspector inspector)

Description copied from interface: BufferAggregator

Implementations of this method should call inspector.visit() with all fields of this class, which meet two conditions: 1. They are used in methods of this class, annotated with CalledFromHotLoop 2. They are either: a. Nullable objects b. Instances of HotLoopCallee c. Objects, which don't always have a specific class in runtime. For example, a field of type Set could be HashSet or TreeSet in runtime, depending on how this instance (the instance on which inspectRuntimeShape() is called) is configured. d. ByteBuffer or similar objects, where byte order matters e. boolean flags, affecting branch taking f. Arrays of objects, meeting any of conditions a-e.

The default implementation inspects nothing. Classes that implement BufferAggregator are encouraged to override this method, following the specification of HotLoopCallee.inspectRuntimeShape(io.druid.query.monomorphicprocessing.RuntimeShapeInspector).

Specified by:

inspectRuntimeShape in interface BufferAggregator

Specified by:

inspectRuntimeShape in interface HotLoopCallee