org.apache.flink.table.runtime.generated.NamespaceAggsHandleFunctionBase Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-table-runtime-blink_2.12 Show documentation

This module contains classes that are required by a task manager for execution of table programs. The content of this module is work-in-progress. It will replace the runtime classes contained in flink-table-planner once it is stable. See FLINK-11439 and FLIP-32 for more details.

The newest version!

/*
 * 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.flink.table.runtime.generated;

import org.apache.flink.api.common.functions.Function;
import org.apache.flink.table.data.RowData;
import org.apache.flink.table.runtime.dataview.StateDataViewStore;

/**
 * The base class for handling aggregate or table aggregate functions.
 *
 * The differences between {@link NamespaceAggsHandleFunctionBase} and {@link
 * AggsHandleFunctionBase} is that the {@link NamespaceAggsHandleFunctionBase} has namespace.
 *
 * @param  type of namespace
 */
public interface NamespaceAggsHandleFunctionBase extends Function {

    /** Initialization method for the function. It is called before the actual working methods. */
    void open(StateDataViewStore store) throws Exception;

    /**
     * Set the current accumulators (saved in a row) which contains the current aggregated results.
     *
     * @param accumulators current accumulators
     */
    void setAccumulators(N namespace, RowData accumulators) throws Exception;

    /**
     * Accumulates the input values to the accumulators.
     *
     * @param inputRow input values bundled in a row
     */
    void accumulate(RowData inputRow) throws Exception;

    /**
     * Retracts the input values from the accumulators.
     *
     * @param inputRow input values bundled in a row
     */
    void retract(RowData inputRow) throws Exception;

    /**
     * Merges the other accumulators into current accumulators.
     *
     * @param otherAcc The other row of accumulators
     */
    void merge(N namespace, RowData otherAcc) throws Exception;

    /**
     * Initializes the accumulators and save them to a accumulators row.
     *
     * @return a row of accumulators which contains the aggregated results
     */
    RowData createAccumulators() throws Exception;

    /**
     * Gets the current accumulators (saved in a row) which contains the current aggregated results.
     *
     * @return the current accumulators
     */
    RowData getAccumulators() throws Exception;

    /** Cleanup for the retired accumulators state. */
    void cleanup(N namespace) throws Exception;

    /**
     * Tear-down method for this function. It can be used for clean up work. By default, this method
     * does nothing.
     */
    void close() throws Exception;
}