org.apache.flink.table.runtime.operators.window.assigners.CountSlidingWindowAssigner 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.operators.window.assigners;

import org.apache.flink.api.common.ExecutionConfig;
import org.apache.flink.api.common.state.ValueState;
import org.apache.flink.api.common.state.ValueStateDescriptor;
import org.apache.flink.api.common.typeinfo.Types;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.table.data.RowData;
import org.apache.flink.table.runtime.operators.window.CountWindow;
import org.apache.flink.table.runtime.operators.window.internal.InternalWindowProcessFunction;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 * A {@link WindowAssigner} that windows elements into sliding windows based on the count number of
 * the elements. Windows can possibly overlap.
 */
public class CountSlidingWindowAssigner extends WindowAssigner {

    private static final long serialVersionUID = 1923778575471995671L;
    private final long windowSize;
    private final long windowSlide;

    private transient ValueState count;

    private CountSlidingWindowAssigner(long windowSize, long windowSlide) {
        if (windowSize <= 0 || windowSlide <= 0) {
            throw new IllegalArgumentException(
                    "SlidingCountWindowAssigner parameters must satisfy slide > 0 and size > 0");
        }
        this.windowSize = windowSize;
        this.windowSlide = windowSlide;
    }

    @Override
    public void open(InternalWindowProcessFunction.Context ctx) throws Exception {
        String descriptorName = "slide-count-assigner";
        ValueStateDescriptor countDescriptor =
                new ValueStateDescriptor<>(descriptorName, Types.LONG);
        this.count = ctx.getPartitionedState(countDescriptor);
    }

    @Override
    public Collection assignWindows(RowData element, long timestamp)
            throws IOException {
        Long countValue = count.value();
        long currentCount = countValue == null ? 0L : countValue;
        count.update(currentCount + 1);
        long lastId = currentCount / windowSlide;
        long lastStart = lastId * windowSlide;
        long lastEnd = lastStart + windowSize - 1;
        List windows = new ArrayList<>();
        while (lastId >= 0 && lastStart <= currentCount && currentCount <= lastEnd) {
            if (lastStart <= currentCount && currentCount <= lastEnd) {
                windows.add(new CountWindow(lastId));
            }
            lastId--;
            lastStart -= windowSlide;
            lastEnd -= windowSlide;
        }
        return windows;
    }

    @Override
    public TypeSerializer getWindowSerializer(ExecutionConfig executionConfig) {
        return new CountWindow.Serializer();
    }

    @Override
    public boolean isEventTime() {
        return false;
    }

    @Override
    public String toString() {
        return "CountSlidingWindow(" + windowSize + ", " + windowSlide + ")";
    }

    public static CountSlidingWindowAssigner of(long windowSize, long windowSlide) {
        return new CountSlidingWindowAssigner(windowSize, windowSlide);
    }
}