* 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,
 * See the License for the specific language governing permissions and
 * limitations under the License.

package org.apache.phoenix.hbase.index.scanner;

import java.io.IOException;
import java.util.SortedSet;

import org.apache.hadoop.hbase.Cell;
import org.apache.hadoop.hbase.KeyValue;
import org.apache.hadoop.hbase.KeyValueUtil;
import org.apache.hadoop.hbase.client.Scan;
import org.apache.hadoop.hbase.filter.Filter;
import org.apache.hadoop.hbase.filter.Filter.ReturnCode;
import org.apache.hadoop.hbase.regionserver.KeyValueScanner;
import org.apache.phoenix.hbase.index.covered.KeyValueStore;

 * Combine a simplified version of the logic in the ScanQueryMatcher and the KeyValueScanner. We can get away with this
 * here because we are only concerned with a single MemStore for the index; we don't need to worry about multiple column
 * families or minimizing seeking through file - we just want to iterate the kvs quickly, in-memory.
public class FilteredKeyValueScanner implements KeyValueScanner {

    private KeyValueScanner delegate;
    private Filter filter;

    public FilteredKeyValueScanner(Filter filter, KeyValueStore store) {
        this(filter, store.getScanner());

    private FilteredKeyValueScanner(Filter filter, KeyValueScanner delegate) {
        this.delegate = delegate;
        this.filter = filter;

    public Cell peek() {
        return delegate.peek();

     * Same a {@link KeyValueScanner#next()} except that we filter out the next {@link KeyValue} until we find one that
     * passes the filter.
     * @return the next {@link KeyValue} or <tt>null</tt> if no next {@link KeyValue} is present and passes all the
     *         filters.
    public Cell next() throws IOException {
        return delegate.next();

    public boolean seek(Cell key) throws IOException {
        if (filter.filterAllRemaining()) { return false; }
        // see if we can seek to the next key
        if (!delegate.seek(key)) { return false; }

        return seekToNextUnfilteredKeyValue();

    private boolean seekToNextUnfilteredKeyValue() throws IOException {
        while (true) {
            Cell peeked = delegate.peek();
            // no more key values, so we are done
            if (peeked == null) { return false; }

            // filter the peeked value to see if it should be served
            ReturnCode code = filter.filterKeyValue(peeked);
            switch (code) {
            // included, so we are done
            case INCLUDE:
            case INCLUDE_AND_NEXT_COL:
                return true;
                // not included, so we need to go to the next row
            case SKIP:
            case NEXT_COL:
            case NEXT_ROW:
            // use a seek hint to find out where we should go
            case SEEK_NEXT_USING_HINT:

    public boolean reseek(Cell key) throws IOException {
        return this.seekToNextUnfilteredKeyValue();

    public boolean requestSeek(Cell kv, boolean forward, boolean useBloom) throws IOException {
        return this.reseek(kv);

    public boolean isFileScanner() {
        return false;

    public long getSequenceID() {
        return this.delegate.getSequenceID();

    public boolean shouldUseScanner(Scan scan, SortedSet<byte[]> columns, long oldestUnexpiredTS) {
        throw new UnsupportedOperationException(this.getClass().getName()
                + " doesn't support checking to see if it should use a scanner!");

    public boolean realSeekDone() {
        return this.delegate.realSeekDone();

    public void enforceSeek() throws IOException {

    public void close() {

    public boolean backwardSeek(Cell arg0) throws IOException {
        return this.delegate.backwardSeek(arg0);

    public boolean seekToLastRow() throws IOException {
        return this.delegate.seekToLastRow();

    public boolean seekToPreviousRow(Cell arg0) throws IOException {
        return this.delegate.seekToPreviousRow(arg0);

    // Added for compatibility with HBASE-13109
    // Once we drop support for older versions, add an @override annotation here
    // and figure out how to get the next indexed key
    public Cell getNextIndexedKey() {
        return null; // indicate that we cannot use the optimization