/*
 * 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.kylin.engine.mr;

import org.apache.kylin.job.execution.DefaultChainedExecutable;
import org.apache.kylin.metadata.model.IJoinedFlatTableDesc;
import org.apache.kylin.metadata.model.ISegment;

public interface IInput {

    /**
     * Return a helper to participate in batch cubing job flow.
     */
    public IBatchCubingInputSide getBatchCubingInputSide(IJoinedFlatTableDesc flatDesc);

    /**
     * Return a helper to participate in batch cubing merge job flow.
     */
    public IBatchMergeInputSide getBatchMergeInputSide(ISegment seg);

    public interface IBatchCubingInputSide {
        /**
         * Add step that creates an intermediate flat table as defined by CubeJoinedFlatTableDesc
         */
        public void addStepPhase1_CreateFlatTable(DefaultChainedExecutable jobFlow);

        /**
         * An optional step that replace/encode flat table with Hive Global Dictionary
         */
        public void addStepPhase_ReplaceFlatTableGlobalColumnValue(DefaultChainedExecutable jobFlow);

        /**
         * Add step that does necessary clean up, like delete the intermediate flat table
         */
        public void addStepPhase4_Cleanup(DefaultChainedExecutable jobFlow);
    }

    public interface IBatchMergeInputSide {

        /**
         * Add step that executes before merge dictionary and before merge cube.
         */
        public void addStepPhase1_MergeDictionary(DefaultChainedExecutable jobFlow);

    }
}
