modules/core/src/main/java/org/apache/ignite/spi/indexing/IndexingQueryFilter.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.ignite.spi.indexing;

import org.apache.ignite.lang.IgniteBiPredicate;
import org.jetbrains.annotations.Nullable;

/**
 * Cache entry filter.
 */
public interface IndexingQueryFilter {
    /**
     * Creates optional predicate for space.
     *
     * @param spaceName Space name.
     * @return Predicate or {@code null} if no filtering is needed.
     */
    @Nullable public <K, V> IgniteBiPredicate<K, V> forSpace(@Nullable String spaceName);

    /**
     * Is the value required for filtering logic?
     * If false then null instead of value will be passed
     * to IgniteBiPredicate returned by {@link #forSpace(String)} method.
     *
     * @return true if value is required for filtering, false otherwise.
     */
    public boolean isValueRequired();
}