WindowFramer (Drill : Exec : Java Execution Engine 1.20.0 API)

All Known Implementing Classes:

FrameSupportTemplate, NoFrameSupportTemplate
```
public interface WindowFramer
```

Field Summary

Fields
Modifier and Type	Field and Description
`static TemplateClassDefinition<WindowFramer>`	`FRAME_TEMPLATE_DEFINITION`
`static TemplateClassDefinition<WindowFramer>`	`NOFRAME_TEMPLATE_DEFINITION`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`cleanup()`
`void`	`doWork()` process the inner batch and write the aggregated values in the container
`int`	`getOutputCount()`
`boolean`	`isPeer(int b1Index, VectorAccessible b1, int b2Index, VectorAccessible b2)` compares two rows from different batches (can be the same), if they have the same value for the order by expression
`boolean`	`isSamePartition(int b1Index, VectorAccessible b1, int b2Index, VectorAccessible b2)` compares two rows from different batches (can be the same), if they have the same value for the partition by expression
`void`	`setup(List<WindowDataBatch> batches, VectorContainer container, OperatorContext operatorContext, boolean requireFullPartition, WindowPOP popConfig)`

Field Detail

NOFRAME_TEMPLATE_DEFINITION

static final TemplateClassDefinition<WindowFramer> NOFRAME_TEMPLATE_DEFINITION

FRAME_TEMPLATE_DEFINITION

static final TemplateClassDefinition<WindowFramer> FRAME_TEMPLATE_DEFINITION

Method Detail

setup

void setup(List<WindowDataBatch> batches,
           VectorContainer container,
           OperatorContext operatorContext,
           boolean requireFullPartition,
           WindowPOP popConfig)
    throws SchemaChangeException

Throws:: SchemaChangeException

doWork
```
void doWork()
     throws SchemaChangeException
```
process the inner batch and write the aggregated values in the container

Throws:

SchemaChangeException

DrillException

getOutputCount
```
int getOutputCount()
```
Returns:

number rows processed in last batch

cleanup
```
void cleanup()
```

isSamePartition

boolean isSamePartition(@Named(value="b1Index")
                        int b1Index,
                        @Named(value="b1")
                        VectorAccessible b1,
                        @Named(value="b2Index")
                        int b2Index,
                        @Named(value="b2")
                        VectorAccessible b2)
                 throws SchemaChangeException

compares two rows from different batches (can be the same), if they have the same value for the partition by expression

Parameters:: b1Index - index of first row; b1 - batch for first row; b2Index - index of second row; b2 - batch for second row
Returns:: true if the rows are in the same partition
Throws:: SchemaChangeException

isPeer

boolean isPeer(@Named(value="b1Index")
               int b1Index,
               @Named(value="b1")
               VectorAccessible b1,
               @Named(value="b2Index")
               int b2Index,
               @Named(value="b2")
               VectorAccessible b2)
        throws SchemaChangeException

compares two rows from different batches (can be the same), if they have the same value for the order by expression

Parameters:: b1Index - index of first row; b1 - batch for first row; b2Index - index of second row; b2 - batch for second row
Returns:: true if the rows are in the same partition
Throws:: SchemaChangeException

Interface WindowFramer