core/src/main/java/org/apache/calcite/sql/fun/SqlGroupingFunction.java

/*
 * 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.calcite.sql.fun;

import org.apache.calcite.rel.core.AggregateCall;
import org.apache.calcite.rex.RexBuilder;
import org.apache.calcite.rex.RexNode;
import org.apache.calcite.sql.SqlFunctionCategory;
import org.apache.calcite.sql.SqlKind;
import org.apache.calcite.sql.SqlStaticAggFunction;
import org.apache.calcite.sql.type.OperandTypes;
import org.apache.calcite.sql.type.ReturnTypes;
import org.apache.calcite.util.ImmutableBitSet;

import com.google.common.collect.ImmutableList;

import org.checkerframework.checker.nullness.qual.Nullable;

import java.math.BigDecimal;

/**
 * The {@code GROUPING} function. It accepts 1 or more arguments and they must be
 * from the GROUP BY list. The result is calculated from a bitmap (the right most bit
 * is the lowest), which indicates whether an argument is aggregated or grouped
 * -- The N-th bit is lit if the N-th argument is aggregated.
 *
 * <p>Example: {@code GROUPING(deptno, gender)} returns
 * 0 if both deptno and gender are being grouped,
 * 1 if only deptno is being grouped,
 * 2 if only gender is being grouped,
 * 3 if neither deptno nor gender are being grouped.
 *
 * <p>This function is defined in the SQL standard.
 * {@code GROUPING_ID} is a non-standard synonym.
 *
 * <p>Some examples are in {@code agg.iq}.
 */
class SqlGroupingFunction extends SqlAbstractGroupFunction {
  private static final SqlStaticAggFunction STATIC =
      SqlGroupingFunction::constant;

  SqlGroupingFunction(String name) {
    super(name, SqlKind.GROUPING, ReturnTypes.BIGINT, null,
        OperandTypes.ONE_OR_MORE, SqlFunctionCategory.SYSTEM);
  }

  /** Implements {@link SqlStaticAggFunction}. */
  private static @Nullable RexNode constant(RexBuilder rexBuilder,
      ImmutableBitSet groupSet, ImmutableList<ImmutableBitSet> groupSets,
      AggregateCall aggregateCall) {
    // GROUPING(c1, ..., cN) evaluates to zero if every grouping set contains
    // all of c1, ..., cN. For example,
    //
    //   SELECT GROUPING(deptno) AS gd, GROUPING(job) AS gj
    //   FROM Emp
    //   GROUP BY GROUPING SETS (deptno), (deptno, job);
    //
    // "gd" is zero for all rows, because both grouping sets contain "deptno";
    // "gj" is 0 for some rows and 1 for others.
    //
    // Internally we allow GROUPING() with no arguments; it always
    // evaluates to zero.
    final ImmutableBitSet argSet =
        ImmutableBitSet.of(aggregateCall.getArgList());
    if (groupSets.stream().allMatch(set -> set.contains(argSet))) {
      return rexBuilder.makeExactLiteral(BigDecimal.ZERO);
    }

    // GROUPING with one or more arguments
    return null;
  }

  @Override public <T extends Object> @Nullable T unwrap(Class<T> clazz) {
    if (clazz.isInstance(STATIC)) {
      return clazz.cast(STATIC);
    }
    return super.unwrap(clazz);
  }
}