exec/java-exec/src/main/java/org/apache/drill/exec/physical/impl/mergereceiver/MergingReceiverTemplate.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.drill.exec.physical.impl.mergereceiver;

import org.apache.drill.exec.exception.SchemaChangeException;
import org.apache.drill.exec.ops.FragmentContext;
import org.apache.drill.exec.record.RecordBatch;
import org.apache.drill.exec.record.RecordBatchLoader;

import javax.inject.Named;

public abstract class MergingReceiverTemplate implements MergingReceiverGeneratorBase {
  static final org.slf4j.Logger logger = org.slf4j.LoggerFactory.getLogger(MergingReceiverTemplate.class);

  public MergingReceiverTemplate() throws SchemaChangeException { }

  /**
   * Enter the generated setup routine
   * @param context current fragment context
   * @param incomingBatchLoaders one RecordBatchLoader per sender
   * @param outgoing outgoing RecordBatch iterator
   * @throws SchemaChangeException
   */
  public abstract void doSetup(@Named("context") FragmentContext context,
                               @Named("incomingBatchLoaders") RecordBatchLoader[] incomingBatchLoaders,
                               @Named("outgoing") RecordBatch outgoing) throws SchemaChangeException;

  /**
   * Enter the generated comparator
   * @param leftNode  reference to the left-hand value and vector
   * @param rightNode reference to the right-hand value and vector
   * @return
   */
  public abstract int doCompare(@Named("leftNode") MergingRecordBatch.Node leftNode,
                                @Named("rightNode") MergingRecordBatch.Node rightNode);

  /**
   * Enter the generated copy function
   * @param inBatch incoming batch to copy from
   * @param inIndex incoming record position to copy from
   * @param outIndex outgoing record position to copy to
   */
  public abstract void doCopy(@Named("inBatch") int inBatch, @Named("inIndex") int inIndex, @Named("outIndex") int outIndex);

//  public abstract void doEval(@Named("inBatch") int inBatch, @Named("inIndex") int inIndex, @Named("outIndex") int outIndex);

}