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.filter.executer;
  
  import java.io.IOException;
  import java.util.BitSet;
  
  import org.apache.carbondata.core.scan.expression.exception.FilterUnsupportedException;
  import org.apache.carbondata.core.scan.filter.intf.RowIntf;
  import org.apache.carbondata.core.scan.processor.RawBlockletColumnChunks;
  import org.apache.carbondata.core.util.BitSetGroup;
  
  public interface FilterExecutor {
  
    /**
     * API will apply filter based on resolver instance
     *
     * @return
     * @throws FilterUnsupportedException
     */
    BitSetGroup applyFilter(RawBlockletColumnChunks rawBlockletColumnChunks,
        boolean useBitsetPipeLine) throws FilterUnsupportedException, IOException;
  
    /**
     * Prune pages as per the filter
     */
    BitSet prunePages(RawBlockletColumnChunks rawBlockletColumnChunks)
        throws FilterUnsupportedException, IOException;
  
    /**
     * apply range filter on a row
     * @return true: if the value satisfy the filter; or else false.
     */
    boolean applyFilter(RowIntf value, int dimOrdinalMax)
        throws FilterUnsupportedException, IOException;
  
    /**
     * API will verify whether the block can be shortlisted based on block
     * max and min key.
     *
     * @param blockMaxValue, maximum value of the
     * @param blockMinValue
     * @param isMinMaxSet  flag to specify whether min max for the filter dimension is written or not
     * @return BitSet
     */
    BitSet isScanRequired(byte[][] blockMaxValue, byte[][] blockMinValue, boolean[] isMinMaxSet);
  
    /**
     * It just reads necessary block for filter executor, it does not uncompress the data.
     *
     * @param rawBlockletColumnChunks
     */
    void readColumnChunks(RawBlockletColumnChunks rawBlockletColumnChunks) throws IOException;
  }
  