org.apache.drill.exec.physical.impl.TopN

Class PriorityQueueTemplate

java.lang.Object

org.apache.drill.exec.physical.impl.TopN.PriorityQueueTemplate

All Implemented Interfaces:

PriorityQueue

public abstract class PriorityQueueTemplate
extends Object
implements PriorityQueue

Field Summary

Fields inherited from interface org.apache.drill.exec.physical.impl.TopN.PriorityQueue

TEMPLATE_DEFINITION

Constructor Summary

Constructors

Constructor and Description
PriorityQueueTemplate()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(RecordBatchData batch) The elements in the given batch are added to the priority queue.
void	cleanup() Releases all the memory consumed by the priority queue.
int	compare(int leftIndex, int rightIndex)
abstract int	doEval(int leftIndex, int rightIndex)
abstract void	doSetup(VectorContainer incoming, RecordBatch outgoing)
void	generate() This method must be called before fetching the final priority queue hyper batch and final Sv4 vector.
SelectionVector4	getFinalSv4() Retrieves the selection vector used to select the elements in the priority queue from the hyper batch provided by the PriorityQueue.getHyperBatch() method.
VectorContainer	getHyperBatch() Retrieves the final priority queue HyperBatch containing the results.
SelectionVector4	getSv4()
void	init(int limit, BufferAllocator allocator, boolean hasSv2) Initializes the priority queue.
int	pop()
void	resetQueue(VectorContainer container, SelectionVector4 v4)
void	swap(int sv0, int sv1)

Methods inherited from class java.lang.Object

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

Constructor Detail

PriorityQueueTemplate

public PriorityQueueTemplate()

Method Detail

init

public void init(int limit,
        BufferAllocator allocator,
        boolean hasSv2)
          throws SchemaChangeException

Description copied from interface: PriorityQueue

Initializes the priority queue. This method must be called before any other methods on the priority queue are called.

Specified by:

init in interface PriorityQueue

Parameters:

limit - The size of the priority queue.

allocator - The BufferAllocator to use when creating the priority queue.

hasSv2 - True when incoming batches have 2 byte selection vectors. False otherwise.

Throws:

SchemaChangeException

resetQueue

public void resetQueue(VectorContainer container,
              SelectionVector4 v4)
                throws SchemaChangeException

Specified by:

resetQueue in interface PriorityQueue

Throws:

SchemaChangeException

add

public void add(RecordBatchData batch)
         throws SchemaChangeException

Description copied from interface: PriorityQueue

The elements in the given batch are added to the priority queue. Note that the priority queue only retains the top elements that fit within the size specified by the PriorityQueue.init(int, BufferAllocator, boolean) method.

Specified by:

add in interface PriorityQueue

Parameters:

batch - The batch containing elements we want to add.

Throws:

SchemaChangeException

generate

public void generate()
              throws SchemaChangeException

Description copied from interface: PriorityQueue

This method must be called before fetching the final priority queue hyper batch and final Sv4 vector.

Specified by:

generate in interface PriorityQueue

Throws:

SchemaChangeException

getHyperBatch

public VectorContainer getHyperBatch()

Description copied from interface: PriorityQueue

Retrieves the final priority queue HyperBatch containing the results. Note: this should be called after PriorityQueue.generate().

Specified by:

getHyperBatch in interface PriorityQueue

Returns:

The final priority queue HyperBatch containing the results.

getSv4

public SelectionVector4 getSv4()

Specified by:

getSv4 in interface PriorityQueue

getFinalSv4

public SelectionVector4 getFinalSv4()

Description copied from interface: PriorityQueue

Retrieves the selection vector used to select the elements in the priority queue from the hyper batch provided by the PriorityQueue.getHyperBatch() method. Note: this should be called after PriorityQueue.generate().

Specified by:

getFinalSv4 in interface PriorityQueue

Returns:

The selection vector used to select the elements in the priority queue.

cleanup

public void cleanup()

Description copied from interface: PriorityQueue

Releases all the memory consumed by the priority queue.

Specified by:

cleanup in interface PriorityQueue

pop

public int pop()

swap

public void swap(int sv0,
        int sv1)

compare

public int compare(int leftIndex,
          int rightIndex)
            throws SchemaChangeException

Throws:

SchemaChangeException

doSetup

public abstract void doSetup(@Named(value="incoming")
           VectorContainer incoming,
           @Named(value="outgoing")
           RecordBatch outgoing)
                      throws SchemaChangeException

Throws:

SchemaChangeException

doEval

public abstract int doEval(@Named(value="leftIndex")
         int leftIndex,
         @Named(value="rightIndex")
         int rightIndex)
                    throws SchemaChangeException

Throws:

SchemaChangeException