All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.flink.runtime.jobgraph.InputOutputFormatContainer Maven / Gradle / Ivy

There is a newer version: 1.13.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.runtime.jobgraph;

import org.apache.flink.api.common.io.InputFormat;
import org.apache.flink.api.common.io.OutputFormat;
import org.apache.flink.api.common.operators.util.UserCodeObjectWrapper;
import org.apache.flink.api.common.operators.util.UserCodeWrapper;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.DelegatingConfiguration;
import org.apache.flink.core.io.InputSplit;
import org.apache.flink.runtime.operators.util.TaskConfig;
import org.apache.flink.util.Preconditions;

import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;

import java.io.Serializable;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * A container for {@link InputFormat InputFormats} and {@link OutputFormat OutputFormats}, along with
 * their {@link Configuration}.
 */
public class InputOutputFormatContainer {

	private final FormatUserCodeTable formats;

	private final Configuration parameters;

	private final ClassLoader userCodeClassLoader;

	public InputOutputFormatContainer(ClassLoader classLoader) {
		this.formats = new FormatUserCodeTable();
		this.parameters = new Configuration();
		this.userCodeClassLoader = checkNotNull(classLoader);
	}

	public InputOutputFormatContainer(TaskConfig config, ClassLoader classLoader) {
		checkNotNull(config);
		this.userCodeClassLoader = checkNotNull(classLoader);

		final UserCodeWrapper wrapper;

		try {
			wrapper = config.getStubWrapper(classLoader);
		} catch (Throwable t) {
			throw new RuntimeException("Deserializing the input/output formats failed: " + t.getMessage(), t);
		}

		if (wrapper == null) {
			throw new RuntimeException("No InputFormat or OutputFormat present in task configuration.");
		}

		try {
			this.formats = wrapper.getUserCodeObject(FormatUserCodeTable.class, classLoader);
		} catch (Throwable t) {
			throw new RuntimeException("Instantiating the input/output formats failed: " + t.getMessage(), t);
		}

		this.parameters = new Configuration();
		Configuration stubParameters = config.getStubParameters();
		for (String key : stubParameters.keySet()) { // copy only the parameters of input/output formats
			parameters.setString(key, stubParameters.getString(key, null));
		}
	}

	public Map>> getInputFormats() {
		return formats.getInputFormats();
	}

	public Map>> getOutputFormats() {
		return formats.getOutputFormats();
	}

	@SuppressWarnings("unchecked")
	public  Pair> getUniqueInputFormat() {
		Map>> inputFormats = formats.getInputFormats();
		Preconditions.checkState(inputFormats.size() == 1);

		Map.Entry>> entry = inputFormats.entrySet().iterator().next();

		return new ImmutablePair<>(entry.getKey(),
			(InputFormat) entry.getValue().getUserCodeObject(InputFormat.class, userCodeClassLoader));
	}

	@SuppressWarnings("unchecked")
	public  Pair> getUniqueOutputFormat() {
		Map>> outputFormats = formats.getOutputFormats();
		Preconditions.checkState(outputFormats.size() == 1);

		Map.Entry>> entry = outputFormats.entrySet().iterator().next();

		return new ImmutablePair<>(entry.getKey(),
			(OutputFormat) entry.getValue().getUserCodeObject(OutputFormat.class, userCodeClassLoader));
	}

	public InputOutputFormatContainer addInputFormat(OperatorID operatorId, InputFormat inputFormat) {
		formats.addInputFormat(operatorId, new UserCodeObjectWrapper<>(inputFormat));
		return this;
	}

	public InputOutputFormatContainer addInputFormat(OperatorID operatorId, UserCodeWrapper> wrapper) {
		formats.addInputFormat(operatorId, wrapper);
		return this;
	}

	public InputOutputFormatContainer addOutputFormat(OperatorID operatorId, OutputFormat outputFormat) {
		formats.addOutputFormat(operatorId, new UserCodeObjectWrapper<>(outputFormat));
		return this;
	}

	public InputOutputFormatContainer addOutputFormat(OperatorID operatorId, UserCodeWrapper> wrapper) {
		formats.addOutputFormat(operatorId, wrapper);
		return this;
	}

	public Configuration getParameters(OperatorID operatorId) {
		return new DelegatingConfiguration(parameters, getParamKeyPrefix(operatorId));
	}

	public InputOutputFormatContainer addParameters(OperatorID operatorId, Configuration parameters) {
		for (String key : parameters.keySet()) {
			addParameters(operatorId, key, parameters.getString(key, null));
		}
		return this;
	}

	public InputOutputFormatContainer addParameters(OperatorID operatorId, String key, String value) {
		parameters.setString(getParamKeyPrefix(operatorId) + key, value);
		return this;
	}

	public void write(TaskConfig config) {
		config.setStubWrapper(new UserCodeObjectWrapper<>(formats));
		config.setStubParameters(parameters);
	}

	private String getParamKeyPrefix(OperatorID operatorId) {
		return operatorId + ".";
	}

	/**
	 * Container for multiple wrappers containing {@link InputFormat} and {@link OutputFormat} code.
	 */
	public static class FormatUserCodeTable implements Serializable {

		private static final long serialVersionUID = 1L;

		private final Map>> inputFormats;
		private final Map>> outputFormats;

		public FormatUserCodeTable() {
			this.inputFormats = new HashMap<>();
			this.outputFormats = new HashMap<>();
		}

		public void addInputFormat(OperatorID operatorId, UserCodeWrapper> wrapper) {
			if (inputFormats.containsKey(checkNotNull(operatorId))) {
				throw new IllegalStateException("The input format has been set for the operator: " + operatorId);
			}

			inputFormats.put(operatorId, checkNotNull(wrapper));
		}

		public void addOutputFormat(OperatorID operatorId, UserCodeWrapper> wrapper) {
			if (outputFormats.containsKey(checkNotNull(operatorId))) {
				throw new IllegalStateException("The output format has been set for the operator: " + operatorId);
			}

			outputFormats.put(operatorId, checkNotNull(wrapper));
		}

		public Map>> getInputFormats() {
			return Collections.unmodifiableMap(inputFormats);
		}

		public Map>> getOutputFormats() {
			return Collections.unmodifiableMap(outputFormats);
		}
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy