| /* |
| * 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.wayang.core.plan.executionplan; |
| |
| import org.apache.wayang.core.optimizer.OptimizationContext; |
| import org.apache.wayang.core.plan.wayangplan.ExecutionOperator; |
| import org.apache.wayang.core.plan.wayangplan.Operator; |
| import org.apache.wayang.core.plan.wayangplan.OutputSlot; |
| import org.apache.wayang.core.platform.ChannelDescriptor; |
| import org.apache.wayang.core.platform.Platform; |
| import org.apache.wayang.core.util.Tuple; |
| |
| /** |
| * Sets up the usage of {@link Channel} in an {@link ExecutionPlan} for a given {@link Platform}. |
| */ |
| public interface ChannelInitializer { |
| |
| /** |
| * <i>Optional operation.</i> |
| * Creates a new {@link Channel} adjacent* to an {@link ExecutionOperator}'s {@code outputSlot}. |
| * <p>* Note that in general the created {@link Channel} is not necessarily directly adjacent to the {@code outputSlot}, |
| * but a chain {@link Channel}s (and {@link ExecutionTask}s) might be in betweeen.</p> |
| * |
| * @param descriptor describes the {@link Channel} to be created |
| * @param outputSlot whose output the {@link Channel} should accept |
| * @param optimizationContext provides estimates and accepts new {@link Operator}s |
| * @return {@link Channel} that is directly output by the {@code outputSlot} and the {@link Channel} that was |
| * actually requested; both are interlinked. |
| */ |
| Tuple<Channel, Channel> setUpOutput(ChannelDescriptor descriptor, OutputSlot<?> outputSlot, OptimizationContext optimizationContext); |
| |
| /** |
| * <i>Optional operation.</i> |
| * Creates a new {@link Channel} incident* to the {@code source}. |
| * <p>* Note that in general the created {@link Channel} is not necessarily directly incident to the {@code source}, |
| * but a chain {@link Channel}s (and {@link ExecutionTask}s) might be in betweeen.</p> |
| * |
| * @param descriptor describes the {@link Channel} to be created |
| * @param source that should be exposed as a new {@link Channel} |
| * @param optimizationContext provides estimates and accepts new {@link Operator}s |
| * @return the set up {@link Channel} |
| */ |
| Channel setUpOutput(ChannelDescriptor descriptor, Channel source, OptimizationContext optimizationContext); |
| |
| /** |
| * Erases the type variable from this instance. |
| * |
| * @return this instance, casted |
| * @deprecated not needed anymore |
| */ |
| @SuppressWarnings("unchecked") |
| default ChannelInitializer unchecked() { |
| return this; |
| } |
| } |