/*
 * 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.
 */

#pragma once

#include <memory>

#include "arrow/c/abi.h"
#include "paimon/result.h"

namespace arrow {
class Schema;
}  // namespace arrow

namespace paimon {

/// Converts logical write batches into a physical (shredded) file layout. Implemented by both
/// the VARIANT shredding and the MAP shared-shredding batch converters so that shredded file
/// writers can be composed generically.
class ShreddingBatchConverter {
 public:
    virtual ~ShreddingBatchConverter() = default;

    /// The physical file schema that converted batches conform to.
    virtual const std::shared_ptr<arrow::Schema>& GetPhysicalSchema() const = 0;

    /// Converts a logical batch into the physical layout. Consumes `logical_batch`.
    virtual Result<std::unique_ptr<::ArrowArray>> Convert(::ArrowArray* logical_batch) = 0;
};

}  // namespace paimon
