/*
 * 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.gobblin.runtime.mapreduce;

import org.apache.hadoop.mapreduce.Mapper;


/**
 * Interfaces methods to obtain customized progress
 */
public interface CustomizedProgresser {

  /**
   * Create an instance of {@link CustomizedProgresser} from Hadoop Mapper's context
   * which contains both MR-related configuration to measure real progress, and Gobblin-job configurations.
   */
  interface Factory {
    public CustomizedProgresser createCustomizedProgresser(Mapper.Context mapperContext);
  }

  /**
   * Calculating progress based on application's requirement.
   * e.g. For Gobblin-Kafka in batch mode, the number of records being written divided by offsets calculated
   * from workunit-planning is one of the good metric to measure mapper's progress.
   */
  float getCustomizedProgress();
}
