/*
 * 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.hudi.common.table.read;

/**
 * Parameters for how the reader should process the FileGroup while reading.
 */
public class ReaderParameters {
  // Rely on the position of the record in the file instead of the record keys while merging data between base and log files
  private final boolean useRecordPosition;
  // Whether to emit delete records while reading
  private final boolean emitDelete;
  // Whether to sort the output records while reading, this implicitly requires the base file to be sorted
  private final boolean sortOutput;
  // Allows to consider inflight instants while merging log records using HoodieMergedLogRecordReader
  // The inflight instants need to be considered while updating RLI records. RLI needs to fetch the revived
  // and deleted keys from the log files written as part of active data commit. During the RLI update,
  // the allowInflightInstants flag would need to be set to true. This would ensure the HoodieMergedLogRecordReader
  // considers the log records which are inflight.
  private final boolean allowInflightInstants;

  private ReaderParameters(boolean useRecordPosition, boolean emitDelete, boolean sortOutput, boolean allowInflightInstants) {
    this.useRecordPosition = useRecordPosition;
    this.emitDelete = emitDelete;
    this.sortOutput = sortOutput;
    this.allowInflightInstants = allowInflightInstants;
  }

  public boolean useRecordPosition() {
    return useRecordPosition;
  }

  public boolean emitDeletes() {
    return emitDelete;
  }

  public boolean sortOutputs() {
    return sortOutput;
  }

  public boolean allowInflightInstants() {
    return allowInflightInstants;
  }

  static Builder builder() {
    return new Builder();
  }

  static class Builder {
    private boolean shouldUseRecordPosition = false;
    private boolean emitDelete = false;
    private boolean sortOutput = false;
    private boolean allowInflightInstants = false;

    public Builder shouldUseRecordPosition(boolean shouldUseRecordPosition) {
      this.shouldUseRecordPosition = shouldUseRecordPosition;
      return this;
    }

    public Builder emitDeletes(boolean emitDelete) {
      this.emitDelete = emitDelete;
      return this;
    }

    public Builder sortOutputs(boolean sortOutput) {
      this.sortOutput = sortOutput;
      return this;
    }

    public Builder allowInflightInstants(boolean allowInflightInstants) {
      this.allowInflightInstants = allowInflightInstants;
      return this;
    }

    public ReaderParameters build() {
      return new ReaderParameters(shouldUseRecordPosition, emitDelete, sortOutput, allowInflightInstants);
    }
  }
}
