/*
 * 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.iotdb.pipe.api.collector;

import org.apache.iotdb.pipe.api.PipeProcessor;
import org.apache.iotdb.pipe.api.event.deletion.DeletionEvent;
import org.apache.iotdb.pipe.api.event.insertion.TabletInsertionEvent;
import org.apache.iotdb.pipe.api.event.insertion.TsFileInsertionEvent;

import java.io.IOException;

/**
 * Used to collect events generated by {@link PipeProcessor#process(TabletInsertionEvent,
 * EventCollector)}, {@link PipeProcessor#process(TsFileInsertionEvent, EventCollector)} or {@link
 * PipeProcessor#process(DeletionEvent, EventCollector)}.
 */
public interface EventCollector {

  /**
   * Collects an insertion event in form of TabletInsertionEvent.
   *
   * @param event TabletInsertionEvent to be collected
   * @throws IOException if any I/O errors occur
   * @see TabletInsertionEvent
   */
  void collectTabletInsertionEvent(TabletInsertionEvent event) throws IOException;

  /**
   * Collects an insertion event in form of TsFileInsertionEvent.
   *
   * @param event TsFileInsertionEvent to be collected
   * @throws IOException if any I/O errors occur
   * @see TsFileInsertionEvent
   */
  void collectTsFileInsertionEvent(TsFileInsertionEvent event) throws IOException;

  /**
   * Collects a deletion event.
   *
   * @param event DeletionEvent to be collected
   * @throws IOException if any I/O errors occur
   * @see DeletionEvent
   */
  void collectDeletionEvent(DeletionEvent event) throws IOException;
}
