iotdb-core/tsfile/src/main/java/org/apache/iotdb/tsfile/write/chunk/IChunkWriter.java

/*
 * 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.tsfile.write.chunk;

import org.apache.iotdb.tsfile.write.writer.TsFileIOWriter;

import java.io.IOException;

/** IChunkWriter provides a list of writing methods for different value types. */
public interface IChunkWriter {

  /** flush data to TsFileIOWriter. */
  void writeToFileWriter(TsFileIOWriter tsfileWriter) throws IOException;

  /** estimate memory usage of this series. */
  long estimateMaxSeriesMemSize();

  /**
   * return the serialized size of the chunk header + all pages (not including the un-sealed page).
   * Notice, call this method before calling writeToFileWriter(), otherwise the page buffer in
   * memory will be cleared. <br>
   * If there is no data points in the chunk, return 0 (i.e., in this case, the size of header is
   * not calculated, because nothing will be serialized latter)</>
   */
  long getSerializedChunkSize();

  /** seal the current page which may has not enough data points in force. */
  void sealCurrentPage();

  /** set the current pageWriter to null, friendly for gc */
  void clearPageWriter();

  /**
   * used for compaction to check whether the chunk is over threshold or not. Return true if there
   * is no unsealed chunk.
   */
  boolean checkIsChunkSizeOverThreshold(long size, long pointNum, boolean returnTrueIfChunkEmpty);

  /** Return true if the chunk writer is empty */
  boolean isEmpty();

  /**
   * used for compaction to check whether the unsealed page is over threshold or not. Return true if
   * there is no unsealed page.
   */
  boolean checkIsUnsealedPageOverThreshold(long size, long pointNum, boolean returnTrueIfPageEmpty);
}