org.apache.flink.streaming.api.functions.windowing.FoldApplyProcessAllWindowFunction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-streaming-java_2.11 Show documentation
There is a newer version: 1.14.6
Show 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.streaming.api.functions.windowing;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.ExecutionConfig;
import org.apache.flink.api.common.functions.FoldFunction;
import org.apache.flink.api.common.functions.RuntimeContext;
import org.apache.flink.api.common.functions.util.FunctionUtils;
import org.apache.flink.api.common.typeinfo.TypeInformation;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.core.memory.DataInputViewStreamWrapper;
import org.apache.flink.core.memory.DataOutputViewStreamWrapper;
import org.apache.flink.streaming.api.operators.OutputTypeConfigurable;
import org.apache.flink.streaming.api.windowing.windows.Window;
import org.apache.flink.util.Collector;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Collections;

/**
 * Internal {@link ProcessAllWindowFunction} that is used for implementing a fold on a window
 * configuration that only allows {@link ProcessAllWindowFunction} and cannot directly execute a
 * {@link FoldFunction}.
 *
 * @deprecated will be removed in a future version
 */
@Internal
@Deprecated
public class FoldApplyProcessAllWindowFunction
	extends ProcessAllWindowFunction
	implements OutputTypeConfigurable {

	private static final long serialVersionUID = 1L;

	private final FoldFunction foldFunction;
	private final ProcessAllWindowFunction windowFunction;

	private byte[] serializedInitialValue;
	private TypeSerializer accSerializer;
	private final TypeInformation accTypeInformation;
	private transient ACC initialValue;
	private transient InternalProcessApplyAllWindowContext ctx;

	public FoldApplyProcessAllWindowFunction(ACC initialValue, FoldFunction foldFunction, ProcessAllWindowFunction windowFunction, TypeInformation accTypeInformation) {
		this.windowFunction = windowFunction;
		this.foldFunction = foldFunction;
		this.initialValue = initialValue;
		this.accTypeInformation = accTypeInformation;
	}

	@Override
	public void open(Configuration configuration) throws Exception {
		FunctionUtils.openFunction(this.windowFunction, configuration);

		if (serializedInitialValue == null) {
			throw new RuntimeException("No initial value was serialized for the fold " +
				"window function. Probably the setOutputType method was not called.");
		}

		ByteArrayInputStream bais = new ByteArrayInputStream(serializedInitialValue);
		DataInputViewStreamWrapper in = new DataInputViewStreamWrapper(bais);
		initialValue = accSerializer.deserialize(in);

		ctx = new InternalProcessApplyAllWindowContext<>(windowFunction);

	}

	@Override
	public void close() throws Exception {
		FunctionUtils.closeFunction(this.windowFunction);
	}

	@Override
	public void setRuntimeContext(RuntimeContext t) {
		super.setRuntimeContext(t);

		FunctionUtils.setFunctionRuntimeContext(this.windowFunction, t);
	}

	@Override
	public void process(final Context context, Iterable values, Collector out) throws Exception {
		ACC result = accSerializer.copy(initialValue);

		for (T val : values) {
			result = foldFunction.fold(result, val);
		}

		this.ctx.window = context.window();
		this.ctx.context = context;

		windowFunction.process(ctx, Collections.singletonList(result), out);
	}

	@Override
	public void clear(final Context context) throws Exception {
		this.ctx.window = context.window();
		this.ctx.context = context;
		windowFunction.clear(ctx);
	}

	@Override
	public void setOutputType(TypeInformation outTypeInfo, ExecutionConfig executionConfig) {
		accSerializer = accTypeInformation.createSerializer(executionConfig);

		ByteArrayOutputStream baos = new ByteArrayOutputStream();
		DataOutputViewStreamWrapper out = new DataOutputViewStreamWrapper(baos);

		try {
			accSerializer.serialize(initialValue, out);
		} catch (IOException ioe) {
			throw new RuntimeException("Unable to serialize initial value of type " +
				initialValue.getClass().getSimpleName() + " of fold window function.", ioe);
		}

		serializedInitialValue = baos.toByteArray();
	}
}