flink-libraries/flink-table/src/main/java/org/apache/flink/table/runtime/window/internal/PanedWindowProcessFunction.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.flink.table.runtime.window.internal;

import org.apache.flink.table.api.window.Window;
import org.apache.flink.table.dataformat.BaseRow;
import org.apache.flink.table.runtime.functions.SubKeyedAggsHandleFunction;
import org.apache.flink.table.runtime.window.assigners.PanedWindowAssigner;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

/**
 * The implementation of {@link InternalWindowProcessFunction} for {@link PanedWindowAssigner}.
 * @param <W> The type of {@code Window} that assigner assigns.
 */
public class PanedWindowProcessFunction<K, W extends Window>
	extends InternalWindowProcessFunction<K, W> {

	private static final long serialVersionUID = 4259335376102569987L;

	private final PanedWindowAssigner<W> windowAssigner;

	public PanedWindowProcessFunction(
		PanedWindowAssigner<W> windowAssigner,
		SubKeyedAggsHandleFunction<W> windowAggregator,
		long allowedLateness) {

		super(windowAssigner, windowAggregator, allowedLateness);
		this.windowAssigner = windowAssigner;
	}

	@Override
	public Collection<W> assignActualWindows(BaseRow inputRow, long timestamp) throws Exception {
		Collection<W> elementWindows = windowAssigner.assignWindows(inputRow, timestamp);
		List<W> actualWindows = new ArrayList<>(elementWindows.size());
		for (W window : elementWindows) {
			if (!isWindowLate(window)) {
				actualWindows.add(window);
			}
		}
		return actualWindows;
	}

	@Override
	public Collection<W> assignStateNamespace(BaseRow inputRow, long timestamp) throws Exception {
		W pane = windowAssigner.assignPane(inputRow, timestamp);
		if (!isPaneLate(pane)) {
			return Collections.singleton(pane);
		} else {
			return Collections.emptyList();
		}
	}

	@Override
	public BaseRow getWindowAggregationResult(W window) throws Exception {
		Iterable<W> panes = windowAssigner.splitIntoPanes(window);
		BaseRow acc = windowAggregator.createAccumulators();
		// null namespace means use heap data views
		windowAggregator.setAccumulators(null, acc);
		for (W pane : panes) {
			BaseRow paneAcc = ctx.getWindowAccumulators(pane);
			if (paneAcc != null) {
				windowAggregator.merge(pane, paneAcc);
			}
		}
		return windowAggregator.getValue(window);
	}

	@Override
	public void cleanWindowIfNeeded(W window, long currentTime) throws Exception {
		if (isCleanupTime(window, currentTime)) {
			Iterable<W> panes = windowAssigner.splitIntoPanes(window);
			for (W pane : panes) {
				W lastWindow = windowAssigner.getLastWindow(pane);
				if (window.equals(lastWindow)) {
					ctx.clearWindowState(pane);
				}
			}
			ctx.clearTrigger(window);
			ctx.clearPreviousState(window);
		}
	}

	/** checks whether the pane is late (e.g. can be / has been cleanup) */
	private boolean isPaneLate(W pane) {
		// whether the pane is late depends on the last window which the pane is belongs to is late
		return windowAssigner.isEventTime() && isWindowLate(windowAssigner.getLastWindow(pane));
	}
}