content: /*
   * 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.carbondata.core.scan.scanner;
  
  import java.io.IOException;
  
  import org.apache.carbondata.core.datastore.DataRefNode;
  import org.apache.carbondata.core.scan.expression.exception.FilterUnsupportedException;
  import org.apache.carbondata.core.scan.processor.RawBlockletColumnChunks;
  import org.apache.carbondata.core.scan.result.BlockletScannedResult;
  
  /**
   * Interface for processing the block
   * Processing can be filter based processing or non filter based processing
   */
  public interface BlockletScanner {
  
    /**
     * Checks whether this blocklet required to scan or not based on min max of each blocklet.
     * @param dataBlock
     * @return
     * @throws IOException
     */
    boolean isScanRequired(DataRefNode dataBlock);
  
    /**
     * Below method will used to process the block data and get the scanned result
     *
     * @param rawBlockletColumnChunks block chunk which holds the block data
     * @return scannerResult
     * result after processing
     */
    BlockletScannedResult scanBlocklet(RawBlockletColumnChunks rawBlockletColumnChunks)
        throws IOException, FilterUnsupportedException;
  
    /**
     * Just reads the blocklet from file, does not uncompress it.
     * @param rawBlockletColumnChunks
     */
    void readBlocklet(RawBlockletColumnChunks rawBlockletColumnChunks) throws IOException;
  
  }
  