org.apache.hadoop.hive.ql.plan.BaseWork Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hive-exec
There is a newer version: 4.0.0
/**
 * 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.hadoop.hive.ql.plan;

import java.util.ArrayList;
import java.util.LinkedList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Stack;

import org.apache.hadoop.hive.ql.exec.HashTableDummyOperator;
import org.apache.hadoop.hive.ql.exec.Operator;
import org.apache.hadoop.mapred.JobConf;
import org.apache.hadoop.hive.ql.plan.Explain.Level;


/**
 * BaseWork. Base class for any "work" that's being done on the cluster. Items like stats
 * gathering that are commonly used regardless of the type of work live here.
 */
@SuppressWarnings({"serial"})
public abstract class BaseWork extends AbstractOperatorDesc {

  // dummyOps is a reference to all the HashTableDummy operators in the
  // plan. These have to be separately initialized when we setup a task.
  // Their function is mainly as root ops to give the mapjoin the correct
  // schema info.
  List dummyOps;
  int tag;
  private final List sortColNames = new ArrayList();

  private MapredLocalWork mrLocalWork;

  public BaseWork() {}

  public BaseWork(String name) {
    setName(name);
  }

  private boolean gatheringStats;

  private String name;

  // Vectorization.

  protected Map vectorColumnNameMap;
  protected Map vectorColumnTypeMap;
  protected Map vectorScratchColumnTypeMap;

  public void setGatheringStats(boolean gatherStats) {
    this.gatheringStats = gatherStats;
  }

  public boolean isGatheringStats() {
    return this.gatheringStats;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public List getDummyOps() {
    return dummyOps;
  }

  public void setDummyOps(List dummyOps) {
    this.dummyOps = dummyOps;
  }

  public void addDummyOp(HashTableDummyOperator dummyOp) {
    if (dummyOps == null) {
      dummyOps = new LinkedList();
    }
    dummyOps.add(dummyOp);
  }

  public abstract void replaceRoots(Map, Operator> replacementMap);

  public abstract Set> getAllRootOperators();

  public Set> getAllOperators() {

    Set> returnSet = new LinkedHashSet>();
    Set> opSet = getAllRootOperators();
    Stack> opStack = new Stack>();

    // add all children
    opStack.addAll(opSet);

    while(!opStack.empty()) {
      Operator op = opStack.pop();
      returnSet.add(op);
      if (op.getChildOperators() != null) {
        opStack.addAll(op.getChildOperators());
      }
    }

    return returnSet;
  }

  /**
   * Returns a set containing all leaf operators from the operator tree in this work.
   * @return a set containing all leaf operators in this operator tree.
   */
  public Set> getAllLeafOperators() {
    Set> returnSet = new LinkedHashSet>();
    Set> opSet = getAllRootOperators();
    Stack> opStack = new Stack>();

    // add all children
    opStack.addAll(opSet);

    while (!opStack.empty()) {
      Operator op = opStack.pop();
      if (op.getNumChild() == 0) {
        returnSet.add(op);
      }
      if (op.getChildOperators() != null) {
        opStack.addAll(op.getChildOperators());
      }
    }

    return returnSet;
  }

  public Map getVectorColumnNameMap() {
    return vectorColumnNameMap;
  }

  public void setVectorColumnNameMap(Map vectorColumnNameMap) {
    this.vectorColumnNameMap = vectorColumnNameMap;
  }

  public Map getVectorColumnTypeMap() {
    return vectorColumnTypeMap;
  }

  public void setVectorColumnTypeMap(Map vectorColumnTypeMap) {
    this.vectorColumnTypeMap = vectorColumnTypeMap;
  }

  public Map getVectorScratchColumnTypeMap() {
    return vectorScratchColumnTypeMap;
  }

  public void setVectorScratchColumnTypeMap(Map vectorScratchColumnTypeMap) {
    this.vectorScratchColumnTypeMap = vectorScratchColumnTypeMap;
  }

  /**
   * @return the mapredLocalWork
   */
  @Explain(displayName = "Local Work", explainLevels = { Level.USER, Level.DEFAULT, Level.EXTENDED })
  public MapredLocalWork getMapRedLocalWork() {
    return mrLocalWork;
  }

  /**
   * @param mapLocalWork
   *          the mapredLocalWork to set
   */
  public void setMapRedLocalWork(final MapredLocalWork mapLocalWork) {
    this.mrLocalWork = mapLocalWork;
  }

  public abstract void configureJobConf(JobConf job);

  public void setTag(int tag) {
    this.tag = tag;
  }

  public int getTag() {
    return tag;
  }

  public void addSortCols(List sortCols) {
    this.sortColNames.addAll(sortCols);
  }

  public List getSortCols() {
    return sortColNames;
  }
}