/*
 * 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.tsfile.read.reader;

import org.apache.tsfile.enums.TSDataType;
import org.apache.tsfile.file.metadata.IMetadata;
import org.apache.tsfile.read.common.BatchData;
import org.apache.tsfile.read.common.block.TsBlock;
import org.apache.tsfile.read.filter.basic.Filter;
import org.apache.tsfile.read.reader.series.PaginationController;

import java.io.IOException;
import java.util.List;
import java.util.function.LongConsumer;

public interface IPageReader extends IMetadata {

  default BatchData getAllSatisfiedPageData() throws IOException {
    return getAllSatisfiedPageData(true);
  }

  BatchData getAllSatisfiedPageData(boolean ascending) throws IOException;

  TsBlock getAllSatisfiedData() throws IOException;

  /**
   * Reads all rows from the page that satisfy the current filter, while also recording the number
   * of rows filtered out.
   *
   * <p>This method behaves identically to {@link #getAllSatisfiedData()}, with the addition that it
   * reports the count of rows that were discarded by the filter to the provided {@code
   * filterRowsRecorder}.
   *
   * @param filterRowsRecorder, receives the number of rows filtered out;
   */
  TsBlock getAllSatisfiedData(LongConsumer filterRowsRecorder) throws IOException;

  void addRecordFilter(Filter filter);

  // The 'modified' property is also true when a data type need to be modified in query and
  // statistics are no longer available.
  boolean isModified();

  void setModified(boolean modified);

  void initTsBlockBuilder(List<TSDataType> dataTypes);

  void setLimitOffset(PaginationController paginationController);
}
